From 6b3adfb5252bc74b8e446b9c8b4ef63d64952e39 Mon Sep 17 00:00:00 2001 From: ivan-nginx Date: Sat, 23 Mar 2019 16:28:36 +0300 Subject: [PATCH 1/5] =?UTF-8?q?Added=20=C2=ABReporting=20Security=20Bugs?= =?UTF-8?q?=C2=BB=20sections.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit P.S. Need to translate section in `zh-CN` file to CN. --- .github/CONTRIBUTING.md | 9 ++++++--- docs/zh-CN/CONTRIBUTING.md | 16 ++++++---------- 2 files changed, 12 insertions(+), 13 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 28bebe4d21..7e78a1571e 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -23,12 +23,10 @@ First of all, thanks for taking your time to contribute and help make our projec * [Labels Rules](#labels-rules) * [Commit Messages Rules](#commit-messages-rules) - ## How Can I Contribute? Main Theme-Next repository was rebased from [iissnan's](https://github.com/iissnan/hexo-theme-next) profile to [Theme-Next](https://github.com/theme-next) organization on GitHub. Most libraries under the `next/source/lib` directory was moved out to [external repos](https://github.com/theme-next) under NexT organization. Version 5 works fine at most cases, but for frequent users, you maybe need to [upgrade version 5 to 6](https://github.com/theme-next/hexo-theme-next/blob/master/docs/UPDATE-FROM-5.1.X.md) to get features and supports in new [Theme-Next](https://github.com/theme-next/hexo-theme-next) repository. - ### Before Submitting An Issue If you just have a question, you'll get faster results by checking the FAQs for a list of common questions and problems (Work in progress) or the [«NexT» Documentation Site](https://theme-next.org/docs/) (Work in progress). @@ -39,7 +37,6 @@ If you find a bug in the source code, most importantly, please check carefully i [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. - ### Reporting Bugs Before creating bug reports, please check [this list](#before-submitting-an-issue) as you might find out that you don't need to create one. After you've determined the repository your bug is related to, create an issue on that repository and provide the information as many details as possible by filling in [the required template](ISSUE_TEMPLATE.md). @@ -58,6 +55,12 @@ Following these guidelines helps maintainers and the community understand your r * Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior. * Explain which behavior you expected to see instead and why. +#### Reporting Security Bugs + +If you find a security issue, please act responsibly and report it not in the public issue tracker, but directly to us, so we can fix it before it can be exploited. Please send the related information to security@theme-next.com (desirable with using PGP for e-mail encryption). + +We will gladly give credit to anyone who reports a vulnerability so that we can fix it. If you want to remain anonymous or pseudonymous instead, please let us know that; we will gladly respect your wishes. + ### Suggesting Enhancements Before creating enhancement suggestions, please check [this list](#before-submitting-an-issue) as you might find out that you don't need to create one. After you've determined the repository your enhancement suggestion is related to, create an issue on that repository and provide the information as many details as possible by filling in [the required template](ISSUE_TEMPLATE.md). diff --git a/docs/zh-CN/CONTRIBUTING.md b/docs/zh-CN/CONTRIBUTING.md index 9e431e608e..f28dc97e3a 100644 --- a/docs/zh-CN/CONTRIBUTING.md +++ b/docs/zh-CN/CONTRIBUTING.md @@ -23,19 +23,16 @@ * [标签规范](#labels-rules) * [提交信息规范](#commit-messages-rules) - ## 如何为 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，你也可以继续提问。 如果你在使用过程中发现了 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 前，请再次确认您已经查看了[你需要了解的](#before-submitting-an-issue)内容，避免提交重复的 Issue。确定相关仓库后，创建 Issue 并按照[模板](../../.github/ISSUE_TEMPLATE.md)尽可能的详细填写相关信息。 @@ -54,7 +51,12 @@ * 详细描述通过上述重现过程出现的问题。 * 详细描述你期待的结果。 - +#### Reporting Security Bugs + +If you find a security issue, please act responsibly and report it not in the public issue tracker, but directly to us, so we can fix it before it can be exploited. Please send the related information to security@theme-next.com (desirable with using PGP for e-mail encryption). + +We will gladly give credit to anyone who reports a vulnerability so that we can fix it. If you want to remain anonymous or pseudonymous instead, please let us know that; we will gladly respect your wishes. + ### 提交功能需求 提交功能需求前，请再次确认您已经查看了[你需要了解的](#before-submitting-an-issue)内容，避免提交重复的 Issue。确定相关仓库后，创建 Issue 并按照[模板](../../.github/ISSUE_TEMPLATE.md)尽可能的详细填写相关信息。 @@ -65,7 +67,6 @@ * 详细描述目前所具有的功能和你所期待的功能，并解释为什么需要该功能。 * 提供功能需求的样例，如图像文件、在线演示网址等等。 - ### 提交合并请求 提交合并请求前，请再次确认您已经查看了[你需要了解的](#before-submitting-an-issue)内容，避免提交重复的合并请求。确定相关仓库后，创建合并请求。更多详细操作过程可以查看[帮助文档](https://help.github.com/articles/creating-a-pull-request/)。 @@ -95,7 +96,6 @@ * 按照[模板](../../.github/PULL_REQUEST_TEMPLATE.md)尽可能的详细填写相关信息。 * 合并请求需要在所有主题样式中测试通过，并提供所表现功能的样例，如图像文件、在线演示网址等等。 - ### 发布版本 版本发布是将项目发布给用户的一种很好的方式。 @@ -111,20 +111,16 @@ 5. 如果您希望随版本一起发布二进制文件（如编译的程序），请在上传二进制文件对话框中手动拖放或选择文件。 6. 如果版本不稳定，请选择 **This is a pre-release**，以通知用户它尚未完全准备好。如果您准备公布您的版本，请点击 **Publish release**。否则，请单击 **Save draft** 以稍后处理。 - ## 规范 - ### 行为规范 为了保证本项目的顺利运作，所有参与人都需要遵守[行为规范](CODE_OF_CONDUCT.md)。 - ### 编码规范 未完待续。 - ### 标签规范 为了方便维护人员和用户能够快速找到他们想要查看的问题，我们使用“标签”功能对拉取请求和问题进行分类。 From b2cd11fc3a128c6cd14d2a89f047d6d97069ced5 Mon Sep 17 00:00:00 2001 From: ivan-nginx Date: Sat, 23 Mar 2019 16:44:21 +0300 Subject: [PATCH 2/5] Fixed TOC sections. --- .github/CONTRIBUTING.md | 25 +++++++++++++++++++++++++ docs/zh-CN/CONTRIBUTING.md | 25 +++++++++++++++++++++++++ 2 files changed, 50 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 7e78a1571e..2fccf29a33 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -12,6 +12,7 @@ First of all, thanks for taking your time to contribute and help make our projec * [Before Submitting An Issue](#before-submitting-an-issue) * [Reporting Bugs](#reporting-bugs) + * [Reporting Security Bugs](#reporting-security-bugs) * [Suggesting Enhancements](#suggesting-enhancements) * [Submitting a Pull Request](#submitting-a-pull-request) * [Creating Releases](#creating-releases) @@ -23,10 +24,14 @@ First of all, thanks for taking your time to contribute and help make our projec * [Labels Rules](#labels-rules) * [Commit Messages Rules](#commit-messages-rules) + + ## How Can I Contribute? Main Theme-Next repository was rebased from [iissnan's](https://github.com/iissnan/hexo-theme-next) profile to [Theme-Next](https://github.com/theme-next) organization on GitHub. Most libraries under the `next/source/lib` directory was moved out to [external repos](https://github.com/theme-next) under NexT organization. Version 5 works fine at most cases, but for frequent users, you maybe need to [upgrade version 5 to 6](https://github.com/theme-next/hexo-theme-next/blob/master/docs/UPDATE-FROM-5.1.X.md) to get features and supports in new [Theme-Next](https://github.com/theme-next/hexo-theme-next) repository. + + ### Before Submitting An Issue If you just have a question, you'll get faster results by checking the FAQs for a list of common questions and problems (Work in progress) or the [«NexT» Documentation Site](https://theme-next.org/docs/) (Work in progress). @@ -37,6 +42,8 @@ If you find a bug in the source code, most importantly, please check carefully i [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. + + ### Reporting Bugs Before creating bug reports, please check [this list](#before-submitting-an-issue) as you might find out that you don't need to create one. After you've determined the repository your bug is related to, create an issue on that repository and provide the information as many details as possible by filling in [the required template](ISSUE_TEMPLATE.md). @@ -55,12 +62,16 @@ Following these guidelines helps maintainers and the community understand your r * Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior. * Explain which behavior you expected to see instead and why. + + #### Reporting Security Bugs If you find a security issue, please act responsibly and report it not in the public issue tracker, but directly to us, so we can fix it before it can be exploited. Please send the related information to security@theme-next.com (desirable with using PGP for e-mail encryption). We will gladly give credit to anyone who reports a vulnerability so that we can fix it. If you want to remain anonymous or pseudonymous instead, please let us know that; we will gladly respect your wishes. + + ### Suggesting Enhancements Before creating enhancement suggestions, please check [this list](#before-submitting-an-issue) as you might find out that you don't need to create one. After you've determined the repository your enhancement suggestion is related to, create an issue on that repository and provide the information as many details as possible by filling in [the required template](ISSUE_TEMPLATE.md). @@ -71,6 +82,8 @@ Following these guidelines helps maintainers and the community understand your s * Describe the current behavior and explain which behavior you expected to see instead and Explain why this enhancement would be useful to most users. * Provide specific examples to demonstrate the suggestion. Include links to files (screenshots or GIFs) or live demo. + + ### Submitting a Pull Request Before creating a Pull Request (PR), please check [this list](#before-submitting-an-issue) as you might find out that you don't need to create one. After you've determined the repository your pull request is related to, create a pull request on that repository. The detailed document of creating a pull request can be found [here](https://help.github.com/articles/creating-a-pull-request/). @@ -100,6 +113,8 @@ Following these guidelines helps maintainers and the community understand your p * Fill in [the required template](PULL_REQUEST_TEMPLATE.md) as many details as possible. * All features or bug fixes must be tested in all schemes. And provide specific examples to demonstrate the pull request. Include links to files (screenshots or GIFs) or live demo. + + ### Creating Releases Releases are a great way to ship projects on GitHub to your users. @@ -115,16 +130,24 @@ Releases are a great way to ship projects on GitHub to your users. 5. If you'd like to include binary files along with your release, such as compiled programs, drag and drop or select files manually in the binaries box. 6. If the release is unstable, select **This is a pre-release** to notify users that it's not ready for production. If you're ready to publicize your release, click **Publish release**. Otherwise, click **Save draft** to work on it later. + + ## Guides + + ### Coding Rules This project and everyone participating in it is governed by the [Code of Conduct](CODE_OF_CONDUCT.md) to keep open and inclusive. By participating, you are expected to uphold this code. + + ### Coding Standards To be continued. + + ### Labels Rules We use "labels" in the issue tracker to help classify pull requests and issues. Using labels enables maintainers and users to quickly find issues they should look into, either because they experience them, or because it meets their area of expertise. @@ -185,6 +208,8 @@ Pull requests related: - `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 + + ### Commit Messages Rules We have very precise rules over how our git commit messages can be formatted. Each commit message consists of a `type` and a `subject`. This leads to more diff --git a/docs/zh-CN/CONTRIBUTING.md b/docs/zh-CN/CONTRIBUTING.md index f28dc97e3a..397d0a12af 100644 --- a/docs/zh-CN/CONTRIBUTING.md +++ b/docs/zh-CN/CONTRIBUTING.md @@ -12,6 +12,7 @@ * [你需要了解的](#before-submitting-an-issue) * [反馈 Bug](#reporting-bugs) + * [Reporting Security Bugs](#reporting-security-bugs) * [提交功能需求](#suggesting-enhancements) * [提交合并请求](#submitting-a-pull-request) * [发布版本](#creating-releases) @@ -23,16 +24,22 @@ * [标签规范](#labels-rules) * [提交信息规范](#commit-messages-rules) + + ## 如何为 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，你也可以继续提问。 如果你在使用过程中发现了 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 前，请再次确认您已经查看了[你需要了解的](#before-submitting-an-issue)内容，避免提交重复的 Issue。确定相关仓库后，创建 Issue 并按照[模板](../../.github/ISSUE_TEMPLATE.md)尽可能的详细填写相关信息。 @@ -51,12 +58,16 @@ * 详细描述通过上述重现过程出现的问题。 * 详细描述你期待的结果。 + + #### Reporting Security Bugs If you find a security issue, please act responsibly and report it not in the public issue tracker, but directly to us, so we can fix it before it can be exploited. Please send the related information to security@theme-next.com (desirable with using PGP for e-mail encryption). We will gladly give credit to anyone who reports a vulnerability so that we can fix it. If you want to remain anonymous or pseudonymous instead, please let us know that; we will gladly respect your wishes. + + ### 提交功能需求 提交功能需求前，请再次确认您已经查看了[你需要了解的](#before-submitting-an-issue)内容，避免提交重复的 Issue。确定相关仓库后，创建 Issue 并按照[模板](../../.github/ISSUE_TEMPLATE.md)尽可能的详细填写相关信息。 @@ -67,6 +78,8 @@ We will gladly give credit to anyone who reports a vulnerability so that we can * 详细描述目前所具有的功能和你所期待的功能，并解释为什么需要该功能。 * 提供功能需求的样例，如图像文件、在线演示网址等等。 + + ### 提交合并请求 提交合并请求前，请再次确认您已经查看了[你需要了解的](#before-submitting-an-issue)内容，避免提交重复的合并请求。确定相关仓库后，创建合并请求。更多详细操作过程可以查看[帮助文档](https://help.github.com/articles/creating-a-pull-request/)。 @@ -96,6 +109,8 @@ We will gladly give credit to anyone who reports a vulnerability so that we can * 按照[模板](../../.github/PULL_REQUEST_TEMPLATE.md)尽可能的详细填写相关信息。 * 合并请求需要在所有主题样式中测试通过，并提供所表现功能的样例，如图像文件、在线演示网址等等。 + + ### 发布版本 版本发布是将项目发布给用户的一种很好的方式。 @@ -111,16 +126,24 @@ We will gladly give credit to anyone who reports a vulnerability so that we can 5. 如果您希望随版本一起发布二进制文件（如编译的程序），请在上传二进制文件对话框中手动拖放或选择文件。 6. 如果版本不稳定，请选择 **This is a pre-release**，以通知用户它尚未完全准备好。如果您准备公布您的版本，请点击 **Publish release**。否则，请单击 **Save draft** 以稍后处理。 + + ## 规范 + + ### 行为规范 为了保证本项目的顺利运作，所有参与人都需要遵守[行为规范](CODE_OF_CONDUCT.md)。 + + ### 编码规范 未完待续。 + + ### 标签规范 为了方便维护人员和用户能够快速找到他们想要查看的问题，我们使用“标签”功能对拉取请求和问题进行分类。 @@ -181,6 +204,8 @@ Pull requests 的标签： - `v6.x`: NexT v6.x 旧版相关的修复和优化类型 Pull request - `v7.x`: NexT v7.x 旧版相关的修复和优化类型 Pull request + + ### 提交信息规范 我们对项目的 git 提交信息格式进行统一格式约定，每条提交信息由 `type`+`subject` 组成，这将提升项目日志的可读性。 From 55e4b37668549f49cec11f07933f1452b8eb9fc7 Mon Sep 17 00:00:00 2001 From: 1v9 Date: Sun, 24 Mar 2019 00:44:29 +0800 Subject: [PATCH 3/5] CN translation I'm not sure how to translate credit to Chinese. --- docs/zh-CN/CONTRIBUTING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/zh-CN/CONTRIBUTING.md b/docs/zh-CN/CONTRIBUTING.md index 397d0a12af..9260c2bbd0 100644 --- a/docs/zh-CN/CONTRIBUTING.md +++ b/docs/zh-CN/CONTRIBUTING.md @@ -12,7 +12,7 @@ * [你需要了解的](#before-submitting-an-issue) * [反馈 Bug](#reporting-bugs) - * [Reporting Security Bugs](#reporting-security-bugs) + * [提交漏洞](#reporting-security-bugs) * [提交功能需求](#suggesting-enhancements) * [提交合并请求](#submitting-a-pull-request) * [发布版本](#creating-releases) @@ -60,11 +60,11 @@ -#### Reporting Security Bugs +#### 提交漏洞 -If you find a security issue, please act responsibly and report it not in the public issue tracker, but directly to us, so we can fix it before it can be exploited. Please send the related information to security@theme-next.com (desirable with using PGP for e-mail encryption). +如果你发现安全问题，请以负责任的方式行事，即不要在公共 Issue 中提交而是直接向我们反馈，这样我们就可以在漏洞被利用之前对其进行修复。请将相关信息发送到 security@theme-next.com（可接受 PGP 加密邮件）。 -We will gladly give credit to anyone who reports a vulnerability so that we can fix it. If you want to remain anonymous or pseudonymous instead, please let us know that; we will gladly respect your wishes. +我们很乐意对任何报告漏洞的人予以肯定以便我们修复它。如果你想保持匿名性或使用笔名替代，请告诉我们。我们将充分尊重你的意愿。 From 88710eff863f7cff5f820687c248d275be542911 Mon Sep 17 00:00:00 2001 From: ivan-nginx Date: Sat, 23 Mar 2019 19:52:34 +0300 Subject: [PATCH 4/5] =?UTF-8?q?Change=20=C2=ABCredit=C2=BB=20=20to=20?= =?UTF-8?q?=C2=ABThanks=C2=BB.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 2fccf29a33..8e74931a05 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -68,7 +68,7 @@ Following these guidelines helps maintainers and the community understand your r If you find a security issue, please act responsibly and report it not in the public issue tracker, but directly to us, so we can fix it before it can be exploited. Please send the related information to security@theme-next.com (desirable with using PGP for e-mail encryption). -We will gladly give credit to anyone who reports a vulnerability so that we can fix it. If you want to remain anonymous or pseudonymous instead, please let us know that; we will gladly respect your wishes. +We will gladly special thanks to anyone who reports a vulnerability so that we can fix it. If you want to remain anonymous or pseudonymous instead, please let us know that; we will gladly respect your wishes. From 976c771b99f6896c3672de8fb9ba175ee2f6ca3b Mon Sep 17 00:00:00 2001 From: 1v9 Date: Sun, 24 Mar 2019 01:07:25 +0800 Subject: [PATCH 5/5] update CN translation --- docs/zh-CN/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/zh-CN/CONTRIBUTING.md b/docs/zh-CN/CONTRIBUTING.md index 9260c2bbd0..a29cc397db 100644 --- a/docs/zh-CN/CONTRIBUTING.md +++ b/docs/zh-CN/CONTRIBUTING.md @@ -64,7 +64,7 @@ 如果你发现安全问题，请以负责任的方式行事，即不要在公共 Issue 中提交而是直接向我们反馈，这样我们就可以在漏洞被利用之前对其进行修复。请将相关信息发送到 security@theme-next.com（可接受 PGP 加密邮件）。 -我们很乐意对任何报告漏洞的人予以肯定以便我们修复它。如果你想保持匿名性或使用笔名替代，请告诉我们。我们将充分尊重你的意愿。 +我们很乐意对任何提交漏洞的人予以特别感谢以便我们修复它。如果你想保持匿名性或使用笔名替代，请告诉我们。我们将充分尊重你的意愿。