From 31b3a282a4e8b0ad45f5fbfc20295bb808796f62 Mon Sep 17 00:00:00 2001 From: Mimi <1119186082@qq.com> Date: Fri, 15 May 2020 00:07:16 +0800 Subject: [PATCH] Update docs --- .github/CODE_OF_CONDUCT.md | 4 ++-- .github/CONTRIBUTING.md | 21 ++++++--------------- .github/ISSUE_TEMPLATE/bug-report.md | 4 ++-- .github/ISSUE_TEMPLATE/feature-request.md | 4 ++-- .github/ISSUE_TEMPLATE/other.md | 4 ++-- .github/ISSUE_TEMPLATE/question.md | 4 ++-- .github/PULL_REQUEST_TEMPLATE.md | 6 +++--- .github/issue-close-app.yml | 2 +- .github/release-drafter.yml | 2 +- .github/stale.yml | 2 +- .github/support.yml | 2 +- README.md | 2 +- docs/ru/README.md | 2 +- docs/zh-CN/CONTRIBUTING.md | 11 +---------- docs/zh-CN/README.md | 2 +- 15 files changed, 27 insertions(+), 45 deletions(-) diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md index 27ce64e..40515f2 100644 --- a/.github/CODE_OF_CONDUCT.md +++ b/.github/CODE_OF_CONDUCT.md @@ -5,11 +5,11 @@ :ru: -#
e x T
+#
e x T
[NexT](https://theme-next.js.org) is an elegant and powerful theme for [Hexo](https://hexo.io/). With it, you can build a static blog hosted on [GitHub Pages](https://pages.github.com/) to share your life and communicate with new friends. -A CODE_OF_CONDUCT dictates how conversation during code updates, issue communication, and pull requests should happen within [NexT](https://github.com/theme-next/hexo-theme-next) repository. We expect all users to show respect and courtesy to others through our repositories. Anyone violating these rules will not be reviewed and will be blocked and expelled from our repositories immediately upon discovery. +A CODE_OF_CONDUCT dictates how conversation during code updates, issue communication, and pull requests should happen within [NexT](https://github.com/next-theme/hexo-theme-next) repository. We expect all users to show respect and courtesy to others through our repositories. Anyone violating these rules will not be reviewed and will be blocked and expelled from our repositories immediately upon discovery. ## Table Of Contents diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index c27a514..f6ef6b4 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -5,9 +5,9 @@ :ru: -#
e x T
+#
e x T
-First of all, thanks for taking your time to contribute and help make our project even better than it is today! The following is a set of guidelines for contributing to [Theme-Next](https://github.com/theme-next) and its libs submodules. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. +First of all, thanks for taking your time to contribute and help make our project even better than it is today! The following is a set of guidelines for contributing to [Theme Next](https://github.com/next-theme) and its libs submodules. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. ## Table Of Contents @@ -37,22 +37,13 @@ First of all, thanks for taking your time to contribute and help make our projec If you just have a question, you'll get faster results by checking the [FAQs for a list of common questions and problems](https://theme-next.js.org/docs/faqs) or the [troubleshooting part of «NexT» Documentation Site](https://theme-next.js.org/docs/troubleshooting). -Also, you can perform a [cursory search](https://github.com/theme-next/hexo-theme-next/search?q=&type=Issues&utf8=%E2%9C%93) to see if the problem has already been reported or solved. You don't want to duplicate effort. You might be able to find the cause of the problem and fix things yourself, or add comments to the existed issue. +Also, you can perform a [cursory search](https://github.com/next-theme/hexo-theme-next/search?q=&type=Issues&utf8=%E2%9C%93) to see if the problem has already been reported or solved. You don't want to duplicate effort. You might be able to find the cause of the problem and fix things yourself, or add comments to the existed issue. #### Quick debug instructions -Before submitting an Issue on GitHub, you can follow the steps below to debug: +Before submitting an Issue on GitHub, you can follow our [Quick debug instructions](https://theme-next.js.org/docs/troubleshooting.html#Quick-Debug-Instructions) to debug. -* Execute `hexo clean`, clear the browser cache and disable all CDN services (e.g. Cloudflare Rocket Loader) -* Switch to another theme and check if the bug still exists (e.g. default theme landscape). In other words, prove that this is a NexT issue, not a issue from Hexo. -* Upgrade theme NexT to the latest version. -* Upgrade Hexo and Hexo plugins to the latest version. -* Upgrade Node.js and `npm` to the latest version. -* Uninstall all non-essential Hexo plugins, or reinstall all plugins using `npm install --save`. - -If you get an error message from Hexo or your browser, please search in Google / Stackoverflow / GitHub Issues, or report it to us when submitting a new Issue. - -If you find a bug in the source code, most importantly, please check carefully if you can reproduce the problem [in the latest release version of Next](https://github.com/theme-next/hexo-theme-next/releases/latest). Then, you can help us by [Reporting Bugs](#reporting-bugs) or [Suggesting Enhancements](#suggesting-enhancements) to our [Repository](https://github.com/theme-next/hexo-theme-next). Even better, you can [submit a Pull Request](#submitting-a-pull-request) with a fix. +If you find a bug in the source code, most importantly, please check carefully if you can reproduce the problem [in the latest release version of Next](https://github.com/next-theme/hexo-theme-next/releases/latest). Then, you can help us by [Reporting Bugs](#reporting-bugs) or [Suggesting Enhancements](#suggesting-enhancements) to our [Repository](https://github.com/next-theme/hexo-theme-next). Even better, you can [submit a Pull Request](#submitting-a-pull-request) with a fix. ### Reporting Bugs @@ -64,7 +55,7 @@ Following these guidelines helps maintainers and the community understand your r * Provide more context by answering these questions: * Can you reproduce the problem? Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens. * Did the problem start happening recently or was this always a problem? - * If the problem started happening recently, can you reproduce the problem in an older version of Next? What's the most recent version in which the problem doesn't happen? You can download older versions of Next from [the releases page](https://github.com/theme-next/hexo-theme-next/releases). + * If the problem started happening recently, can you reproduce the problem in an older version of Next? What's the most recent version in which the problem doesn't happen? You can download older versions of Next from [the releases page](https://github.com/next-theme/hexo-theme-next/releases). * Which version of Node, Hexo and Next are you using? You can get the exact version by running `node -v`, `hexo version` in your terminal, or copy the contents in site's`package.json`. * Which packages do you have installed? You can get that list by copying the contents in site's`package.json`. * Describe the exact steps which reproduce the problem in as many details as possible. When listing steps, don't just say what you did, but explain how you did it, e.g. which command exactly you used. If you're providing snippets in the issue, use [Markdown code blocks](https://help.github.com/articles/creating-and-highlighting-code-blocks/) or [a permanent link to a code snippet](https://help.github.com/articles/creating-a-permanent-link-to-a-code-snippet/), or a [Gist link](https://gist.github.com/). diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 35667c9..dbd94dc 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -13,9 +13,9 @@ Please follow this Issue template to provide relevant information, such as sourc ## Issue Checklist -- [ ] I am using [the latest](https://github.com/theme-next/hexo-theme-next/releases/latest) version of NexT. +- [ ] I am using [the latest](https://github.com/next-theme/hexo-theme-next/releases/latest) version of NexT. - [ ] I have read the relevant documents of [Hexo](https://hexo.io/docs/) and [NexT](https://theme-next.js.org/docs/). -- [ ] I have reviewed the latest Roadmap on GitHub and searched for current [issues](https://github.com/theme-next/hexo-theme-next/issues), which does not help me. +- [ ] I have reviewed the latest Roadmap on GitHub and searched for current [issues](https://github.com/next-theme/hexo-theme-next/issues), which does not help me. *** diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md index e871b94..ea70484 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -13,9 +13,9 @@ Please follow this Issue template to provide relevant information, such as sourc ## Issue Checklist -- [ ] I am using [the latest](https://github.com/theme-next/hexo-theme-next/releases/latest) version of NexT. +- [ ] I am using [the latest](https://github.com/next-theme/hexo-theme-next/releases/latest) version of NexT. - [ ] I have read the relevant documents of [Hexo](https://hexo.io/docs/) and [NexT](https://theme-next.js.org/docs/). -- [ ] I have reviewed the latest Roadmap on GitHub and searched for current [issues](https://github.com/theme-next/hexo-theme-next/issues), which does not help me. +- [ ] I have reviewed the latest Roadmap on GitHub and searched for current [issues](https://github.com/next-theme/hexo-theme-next/issues), which does not help me. *** diff --git a/.github/ISSUE_TEMPLATE/other.md b/.github/ISSUE_TEMPLATE/other.md index 3c0ef25..51178bb 100644 --- a/.github/ISSUE_TEMPLATE/other.md +++ b/.github/ISSUE_TEMPLATE/other.md @@ -13,9 +13,9 @@ Please follow this Issue template to provide relevant information, such as sourc ## Issue Checklist -- [ ] I am using [the latest](https://github.com/theme-next/hexo-theme-next/releases/latest) version of NexT. +- [ ] I am using [the latest](https://github.com/next-theme/hexo-theme-next/releases/latest) version of NexT. - [ ] I have read the relevant documents of [Hexo](https://hexo.io/docs/) and [NexT](https://theme-next.js.org/docs/). -- [ ] I have reviewed the latest Roadmap on GitHub and searched for current [issues](https://github.com/theme-next/hexo-theme-next/issues), which does not help me. +- [ ] I have reviewed the latest Roadmap on GitHub and searched for current [issues](https://github.com/next-theme/hexo-theme-next/issues), which does not help me. *** diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md index 6364acd..3c83929 100644 --- a/.github/ISSUE_TEMPLATE/question.md +++ b/.github/ISSUE_TEMPLATE/question.md @@ -13,9 +13,9 @@ Please follow this Issue template to provide relevant information, such as sourc ## Issue Checklist -- [ ] I am using [the latest](https://github.com/theme-next/hexo-theme-next/releases/latest) version of NexT. +- [ ] I am using [the latest](https://github.com/next-theme/hexo-theme-next/releases/latest) version of NexT. - [ ] I have read the relevant documents of [Hexo](https://hexo.io/docs/) and [NexT](https://theme-next.js.org/docs/). -- [ ] I have reviewed the latest Roadmap on GitHub and searched for current [issues](https://github.com/theme-next/hexo-theme-next/issues), which does not help me. +- [ ] I have reviewed the latest Roadmap on GitHub and searched for current [issues](https://github.com/next-theme/hexo-theme-next/issues), which does not help me. *** diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index ca4ef1f..2c224d9 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -9,12 +9,12 @@ ## PR Checklist -- [ ] The commit message follows [guidelines for NexT](https://github.com/theme-next/hexo-theme-next/blob/master/.github/CONTRIBUTING.md). +- [ ] The commit message follows [guidelines for NexT](https://github.com/next-theme/hexo-theme-next/blob/master/.github/CONTRIBUTING.md). - [ ] Tests for the changes was maked (for bug fixes / features). - [ ] Muse | Mist have been tested. - [ ] Pisces | Gemini have been tested. -- [ ] [Docs](https://github.com/theme-next/theme-next.js.org/tree/source/source/docs) in [NexT website](https://theme-next.js.org/docs/) have been added / updated (for features). - +- [ ] [Docs](https://github.com/next-theme/theme-next-docs/tree/master/source/docs) in [NexT website](https://theme-next.js.org/docs/) have been added / updated (for features). + ## PR Type diff --git a/.github/issue-close-app.yml b/.github/issue-close-app.yml index daa3e1e..7149031 100644 --- a/.github/issue-close-app.yml +++ b/.github/issue-close-app.yml @@ -1,5 +1,5 @@ # Comment that will be sent if an issue is judged to be closed. -comment: "This issue has been closed because it does not meet our Issue template. Please read our [guidelines for contributing](https://github.com/theme-next/hexo-theme-next/blob/master/.github/CONTRIBUTING.md#how-can-i-contribute)." +comment: "This issue has been closed because it does not meet our Issue template. Please read our [guidelines for contributing](https://github.com/next-theme/hexo-theme-next/blob/master/.github/CONTRIBUTING.md#how-can-i-contribute)." issueConfigs: # There can be several configs for different kind of issues. - content: diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml index a70af9c..16c75d5 100644 --- a/.github/release-drafter.yml +++ b/.github/release-drafter.yml @@ -34,7 +34,7 @@ template: | *** - For full changes, see the [comparison between $PREVIOUS_TAG and v$NEXT_MINOR_VERSION](https://github.com/theme-next/hexo-theme-next/compare/$PREVIOUS_TAG...v$NEXT_MINOR_VERSION) + For full changes, see the [comparison between $PREVIOUS_TAG and v$NEXT_MINOR_VERSION](https://github.com/next-theme/hexo-theme-next/compare/$PREVIOUS_TAG...v$NEXT_MINOR_VERSION) exclude-labels: - 'Skip Release' diff --git a/.github/stale.yml b/.github/stale.yml index 3af279e..16156a7 100644 --- a/.github/stale.yml +++ b/.github/stale.yml @@ -17,7 +17,7 @@ staleLabel: stale markComment: > This issue has been automatically marked as stale because lack of recent activity. It will be closed if no further activity occurs. Thank you - for your contributions. You can also use our [support channels](https://github.com/theme-next/hexo-theme-next#feedback) to get help with the project. + for your contributions. You can also use our [support channels](https://github.com/next-theme/hexo-theme-next#feedback) to get help with the project. # Comment to post when removing the stale label. Set to `false` to disable unmarkComment: false # Comment to post when closing a stale Issue or Pull Request. Set to `false` to disable diff --git a/.github/support.yml b/.github/support.yml index 6eb9741..b4cdb20 100644 --- a/.github/support.yml +++ b/.github/support.yml @@ -8,7 +8,7 @@ supportLabel: Support supportComment: > :wave: @{issue-author}, we use the issue tracker exclusively for bug reports and feature requests. However, this issue appears to be a support request. - Please use our [support channels](https://github.com/theme-next/hexo-theme-next/tree/master#feedback) to get help with the project. + Please use our [support channels](https://github.com/next-theme/hexo-theme-next/tree/master#feedback) to get help with the project. # Close issues marked as support requests close: true diff --git a/README.md b/README.md index 094ee8d..e5f1202 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ 🇷🇺 -#
e x T
+#
e x T

«NexT» is a high quality elegant Hexo theme. It is crafted from scratch with love. diff --git a/docs/ru/README.md b/docs/ru/README.md index d8db851..2e98ff8 100644 --- a/docs/ru/README.md +++ b/docs/ru/README.md @@ -5,7 +5,7 @@ 🇷🇺 -#

e x T
+#
e x T

«NexT» — элегантная высококачественная тема под Hexo. Сделана с нуля, с любовью. diff --git a/docs/zh-CN/CONTRIBUTING.md b/docs/zh-CN/CONTRIBUTING.md index a9e915e..bfe671b 100644 --- a/docs/zh-CN/CONTRIBUTING.md +++ b/docs/zh-CN/CONTRIBUTING.md @@ -41,16 +41,7 @@ #### 快速调试指南 -在 GitHub 上提交 Issue 前，请先通过以下方法 debug： - -* 执行`hexo clean`，清除浏览器缓存，并禁用 CDN 服务（例如 Cloudflare Rocket Loader）； -* 切换到其它主题并检查 bug 是否仍然存在（例如使用默认主题 landscape）。换言之，证明这是 NexT 主题而非来自 Hexo 的 bug； -* 将 NexT 主题升级到最新版； -* 将 Hexo 和 Hexo 插件升级到最新版； -* 将 Node.js 和 `npm` 升级到最新版； -* 卸载不必要的 Hexo 插件，或重新通过 `npm install --save` 安装插件。 - -如果你得到了来自 Hexo 或浏览器控制台的报错信息，请在 Google / Stackoverflow / GitHub Issue 中搜寻，或在提交 Issue 时报告给我们。 +在 GitHub 上提交 Issue 前，请先查看我们的 [快速调试指南](https://theme-next.js.org/docs/troubleshooting.html#Quick-Debug-Instructions) 来 debug。 如果你在使用过程中发现了 Bug，请再次确认 Bug 在 [最新发布版本](https://github.com/next-theme/hexo-theme-next/releases/latest) 中是否重现。如果 Bug 重现，欢迎你到我们的 [主题仓库](https://github.com/next-theme/hexo-theme-next) 中 [反馈 Bug](#reporting-bugs) 或者 [提交功能需求](#提交功能需求)，也更期待您 [提交合并请求](#提交合并请求)。 diff --git a/docs/zh-CN/README.md b/docs/zh-CN/README.md index 0516b2e..4ccd24d 100644 --- a/docs/zh-CN/README.md +++ b/docs/zh-CN/README.md @@ -5,7 +5,7 @@ 🇷🇺 -#

e x T
+#
e x T

«NexT» 是一款风格优雅的高质量 Hexo 主题，自点点滴滴中用爱雕琢而成。