diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 8e74931a05..f7f51d705f 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -201,12 +201,12 @@ Pull requests related: - `New Feature`: A Pull requests that provides a new feature - `Feature`: A Pull requests that provides an option or addition to existing feature - `Configurations`: A Pull requests related to configurations -- `Optimization`: A Pull requests that optimizates the Next +- `Improvement`: A Pull requests that improves NexT - `i18n`: A Pull requests that makes new languages translation - `Performance`: A Pull requests that improves the performance - `Discussion`: A Pull requests that needs to be discussed -- `v6.x`: A Pull requests that bug fixes and some optimizations related to old NexT version 6 -- `v7.x`: A Pull requests that bug fixes and some optimizations, related to old NexT version 7 +- `v6.x`: A Pull requests that bug fixes and some improvements, related to old NexT version 6 +- `v7.x`: A Pull requests that bug fixes and some improvements, related to old NexT version 7 diff --git a/docs/zh-CN/CONTRIBUTING.md b/docs/zh-CN/CONTRIBUTING.md index a29cc397db..d9769a1258 100644 --- a/docs/zh-CN/CONTRIBUTING.md +++ b/docs/zh-CN/CONTRIBUTING.md @@ -4,11 +4,11 @@ #
e x T
-首先，非常感谢大家抽出宝贵时间来让我们的 NexT 主题越变越好。在这里，我们介绍一下 [NexT 主题及其子模块](https://github.com/theme-next)的开源贡献指南。不过，我们希望大家不要局限于此，更欢迎大家随时进行补充。 +首先，非常感谢大家抽出宝贵时间来让我们的 NexT 主题越变越好。在这里，我们介绍一下 [NexT 主题及其子模块](https://github.com/theme-next) 的开源贡献指南。不过，我们希望大家不要局限于此，更欢迎大家随时进行补充。 ## 目录 -[如何为 Next 做贡献](#how-can-i-contribute) +[如何为 NexT 做贡献](#how-can-i-contribute) * [你需要了解的](#before-submitting-an-issue) * [反馈 Bug](#reporting-bugs) @@ -26,23 +26,23 @@ -## 如何为 Next 做贡献 +## 如何为 NexT 做贡献 -目前 Next 主题已经从 [iissnan](https://github.com/iissnan/hexo-theme-next) 的个人仓库移动到了 [Theme-Next](https://github.com/theme-next) 组织仓库中，并升级到 V6 版本。在 V6+ 版本中，`next/source/lib` 目录下的第三方依赖库将独立放置在 [Theme-Next](https://github.com/theme-next) 组织仓库中。在大多数情况下，NexT V5 版本仍然能够正常运行，但是如果你想获得更多的功能和帮助，还是建议您[升级到 NexT V6+ 版本](https://github.com/theme-next/hexo-theme-next/blob/master/docs/UPDATE-FROM-5.1.X.md)，并移步 [Theme-Next](https://github.com/theme-next/hexo-theme-next) 仓库。 +目前 NexT 主题已经从 [iissnan](https://github.com/iissnan/hexo-theme-next) 的个人仓库移动到了 [Theme-Next](https://github.com/theme-next) 组织仓库中，并升级到 V6 版本。在 V6+ 版本中，`next/source/lib` 目录下的第三方依赖库将独立放置在 [Theme-Next](https://github.com/theme-next) 组织仓库中。在大多数情况下，NexT V5 版本仍然能够正常运行，但是如果你想获得更多的功能和帮助，还是建议您 [升级到 NexT V6+ 版本](https://github.com/theme-next/hexo-theme-next/blob/master/docs/UPDATE-FROM-5.1.X.md)，并移步 [Theme-Next](https://github.com/theme-next/hexo-theme-next) 仓库。 ### 你需要了解的 -如果你在使用过程中遇到了问题，你可以查阅 FAQs（建设中） 或者 [NexT 帮助文档](https://theme-next.org/docs/)（建设中）。另外，你也可以通过[这里](https://github.com/theme-next/hexo-theme-next/search?q=&type=Issues&utf8=%E2%9C%93)进行大致检索，有些问题已经得到解答，你可以自行解决。对于没有解决的 Issue，你也可以继续提问。 +如果你在使用过程中遇到了问题，你可以查阅 FAQs（建设中） 或者 [NexT 帮助文档](https://theme-next.org/docs/)（建设中）。另外，你也可以通过 [这里](https://github.com/theme-next/hexo-theme-next/search?q=&type=Issues&utf8=%E2%9C%93) 进行大致检索，有些问题已经得到解答，你可以自行解决。对于没有解决的 Issue，你也可以继续提问。 -如果你在使用过程中发现了 Bug，请再次确认 Bug 在[最新发布版本](https://github.com/theme-next/hexo-theme-next/releases/latest)中是否重现。如果 Bug 重现，欢迎你到我们的 [Theme-NexT 仓库](https://github.com/theme-next/hexo-theme-next)中[反馈 Bug ](#reporting-bugs) 和[提交功能需求](#suggesting-enhancements)，也更期待您[提交合并请求](#submitting-a-pull-request) +如果你在使用过程中发现了 Bug，请再次确认 Bug 在 [最新发布版本](https://github.com/theme-next/hexo-theme-next/releases/latest) 中是否重现。如果 Bug 重现，欢迎你到我们的 [主题仓库](https://github.com/theme-next/hexo-theme-next) 中 [反馈 Bug ](#reporting-bugs) 或者 [提交功能需求](#suggesting-enhancements)，也更期待您 [提交合并请求](#submitting-a-pull-request)。 ### 反馈 Bug -反馈 Bug 前，请再次确认您已经查看了[你需要了解的](#before-submitting-an-issue)内容，避免提交重复的 Issue。确定相关仓库后，创建 Issue 并按照[模板](../../.github/ISSUE_TEMPLATE.md)尽可能的详细填写相关信息。 +反馈 Bug 前，请再次确认您已经查看了 [你需要了解的](#before-submitting-an-issue) 内容，避免提交重复的 Issue。确定相关仓库后，创建 Issue 并按照 [模板](../../.github/ISSUE_TEMPLATE.md) 尽可能的详细填写相关信息。 请认真遵守如下指南，这样我们才能更好地理解问题，重现问题和解决问题。 @@ -50,7 +50,7 @@ * 参照如下问题尽可能多的提供信息： * Bug 是否能够重现？是一直出现还是偶尔出现？ * Bug 是从什么时候开始发生的？ - * 如果 Bug 突然发生，使用[旧版本主题](https://github.com/theme-next/hexo-theme-next/releases)是否能够重现 Bug？又是从哪个版本开始出现 Bug？ + * 如果 Bug 突然发生，使用 [旧版本主题](https://github.com/theme-next/hexo-theme-next/releases) 是否能够重现 Bug？又是从哪个版本开始出现 Bug？ * 你所使用 Node，Hexo 以及 Next 的版本号多少？你可以运行 `node -v` 和 `hexo version` 获取版本号，或者查看文件 `package.json` 的内容。 * 你使用了哪些插件包？查看文件 `package.json` 的内容即可获取。 * 一步步详细你是如何重现 Bug 的，做了什么，使用了哪些功能等等。如果你需要展示代码段，请使用 [Markdown 代码块](https://help.github.com/articles/creating-and-highlighting-code-blocks/) 或 [Github 预览链接](https://help.github.com/articles/creating-a-permanent-link-to-a-code-snippet/) 或 [Gist 链接](https://gist.github.com/)。 @@ -70,7 +70,7 @@ ### 提交功能需求 -提交功能需求前，请再次确认您已经查看了[你需要了解的](#before-submitting-an-issue)内容，避免提交重复的 Issue。确定相关仓库后，创建 Issue 并按照[模板](../../.github/ISSUE_TEMPLATE.md)尽可能的详细填写相关信息。 +提交功能需求前，请再次确认您已经查看了 [你需要了解的](#before-submitting-an-issue) 内容，避免提交重复的 Issue。确定相关仓库后，创建 Issue 并按照 [模板](../../.github/ISSUE_TEMPLATE.md) 尽可能的详细填写相关信息。 请认真遵守如下指南，这样我们才能更好地理解和开发功能需求:pencil:： @@ -82,9 +82,9 @@ ### 提交合并请求 -提交合并请求前，请再次确认您已经查看了[你需要了解的](#before-submitting-an-issue)内容，避免提交重复的合并请求。确定相关仓库后，创建合并请求。更多详细操作过程可以查看[帮助文档](https://help.github.com/articles/creating-a-pull-request/)。 +提交合并请求前，请再次确认您已经查看了 [你需要了解的](#before-submitting-an-issue) 内容，避免提交重复的合并请求。确定相关仓库后，创建合并请求。更多详细操作过程可以查看 [帮助文档](https://help.github.com/articles/creating-a-pull-request/)。 -1. 进入 [hexo-theme-next](https://github.com/theme-next/hexo-theme-next) 源仓库，点击`Fork`。 +1. 进入 [hexo-theme-next](https://github.com/theme-next/hexo-theme-next) 主页面，点击`Fork`。 2. 进入到已经`Fork`的个人仓库（`https://github.com/username/hexo-theme-next`），点击 **Clone or download** 并复制该仓库地址。选择本地文件夹，并打开 Git Bash ，输入如下命令并回车，即可完成仓库克隆。 ```bash $ git clone git@github.com:username/hexo-theme-next.git @@ -104,9 +104,9 @@ 请认真遵守如下指南，这样我们才能更好地理解你的合并请求： -* 创建合并请求时，请遵守[编码规范](#coding-rules)和[提交信息规范](#commit-messages-rules)。 +* 创建合并请求时，请遵守 [编码规范](#coding-rules) 和 [提交信息规范](#commit-messages-rules)。 * 在标题中清晰准确地描述你的合并请求，不要加入 Issue 编号。 -* 按照[模板](../../.github/PULL_REQUEST_TEMPLATE.md)尽可能的详细填写相关信息。 +* 按照 [模板](../../.github/PULL_REQUEST_TEMPLATE.md) 尽可能的详细填写相关信息。 * 合并请求需要在所有主题样式中测试通过，并提供所表现功能的样例，如图像文件、在线演示网址等等。 @@ -134,7 +134,7 @@ ### 行为规范 -为了保证本项目的顺利运作，所有参与人都需要遵守[行为规范](CODE_OF_CONDUCT.md)。 +为了保证本项目的顺利运作，所有参与人都需要遵守 [行为规范](CODE_OF_CONDUCT.md)。 @@ -153,7 +153,7 @@ Issues 的标签：使用`类型`+`内容`+`结果`的组合 - 类型 - - `Irrelevant`: 与主题 Next 无关的 Issue + - `Irrelevant`: 与 NexT 主题无关的 Issue - `Duplicate`: 已经存在同样 Issue - `Bug`: 提出了 Bug，等待确认 - `Feature Request`: 提出了特性需求的 Issue @@ -165,17 +165,17 @@ Issues 的标签：使用`类型`+`内容`+`结果`的组合 - `Backlog`: 待解决的 Issue - `Meta`: 表明使用条款变更 Issue - 内容 - - `Roadmap`: 与主题 Next 发展相关的 Issue + - `Roadmap`: 与 NexT 主题发展相关的 Issue - `Hexo`: 与 Hexo 相关的 Issue - - `Scheme [1] - Mist`: 与样式 Mist 相关的 Issue - - `Scheme [2] - Muse`: 与样式 Muse 相关的 Issue - - `Scheme [3] - Pisces`: 与样式 Pisces 相关的 Issue - - `Scheme [4] - Gemini`: 与样式 Gemini 相关的 Issue + - `Scheme [1] - Mist`: 与 Mist 样式相关的 Issue + - `Scheme [2] - Muse`: 与 Muse 样式相关的 Issue + - `Scheme [3] - Pisces`: 与 Pisces 样式相关的 Issue + - `Scheme [4] - Gemini`: 与 Gemini 样式相关的 Issue - `3rd Party Service`: 与第三方服务相关的 Issue - `Docs`: 需要添加文档说明的 Issue - - `Configurations`: 与主题 Next 设置相关的 Issue - - `CSS`: 与主题 Next CSS 文件相关的 Issue - - `Custom`: 与主题 Next 个性化相关的 Issue + - `Configurations`: 与 NexT 主题设置相关的 Issue + - `CSS`: 与 NexT 主题 CSS 文件相关的 Issue + - `Custom`: 与 NexT 主题个性化相关的 Issue - `Optimization`: 需要进行优化的 Issue - 结果 - `Wontfix`: 不能或不被修复的 Issue @@ -191,18 +191,18 @@ Issues 的标签：使用`类型`+`内容`+`结果`的组合 Pull requests 的标签： -- `Breaking Change`: 涉及主题 Next 重大架构的 Pull request +- `Breaking Change`: 产生重大变动的 Pull request - `Bug Fix`: 修复 Bug 的 Pull request - `Docs`: 添加了文档说明的 Pull request - `New Feature`: 添加了新特性的 Pull request - `Feature`: 为已存在的特性添加了选项或功能的 Pull request -- `Configurations`: 涉及主题 Next 配置的 Pull request -- `Optimization`: 优化了主题 Next 的 Pull request +- `Configurations`: 涉及 NexT 主题配置的 Pull request +- `Improvement`: 改进了 NexT 主题的 Pull request - `i18n`: 更新了翻译的 Pull request -- `Performance`: 提高了主题 Next 性能的 Pull request +- `Performance`: 提高了 NexT 主题性能的 Pull request - `Discussion`: 需要进行讨论的 Pull request -- `v6.x`: NexT v6.x 旧版相关的修复和优化类型 Pull request -- `v7.x`: NexT v7.x 旧版相关的修复和优化类型 Pull request +- `v6.x`: 与 NexT v6.x 旧版相关的用于修复和改进的 Pull request +- `v7.x`: 与 NexT v7.x 旧版相关的用于修复和改进的 Pull request