Skip to content

Commit

Permalink
Add Labels Rules guideline (#355)
Browse files Browse the repository at this point in the history
  • Loading branch information
Alex LEE authored and ivan-nginx committed Aug 1, 2018
1 parent 42befc3 commit c0852bb
Show file tree
Hide file tree
Showing 2 changed files with 109 additions and 0 deletions.
54 changes: 54 additions & 0 deletions .github/CONTRIBUTING.md
Expand Up @@ -20,6 +20,7 @@ First of all, thanks for taking your time to contribute and help make our projec

* [Coding Rules](#coding-rules)
* [Coding Standards](#coding-standards)
* [Labels Rules](#labels-rules)
* [Commit Messages Rules](#commit-messages-rules)

<a name="how-can-i-contribute"></a>
Expand Down Expand Up @@ -121,6 +122,59 @@ This project and everyone participating in it is governed by the [Code of Conduc

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.

If you are unsure what a label is about or which labels you should apply to a PR or issue, look no further!

Issues related: `types`+`contents`+`results`

- By types
- `Irrelevant`: An irrelevant issue for Next
- `Duplicate`: An issue which had been mentioned
- `Bug`: A detected bug that needs to be confirmed
- `Discussion`: An issue that needs to be discussed
- `Question`: An issue about questions
- `Feature-Request`: An issue that wants a new feature
- `Backlog`: An issue that is to be completed and later compensated
- By contents
- `Roadmap`: An issue about future development
- `Hexo`: An issue related to Hexo
- `Scheme [1] - Mist`: An issue related to Scheme Mist
- `Scheme [2] - Muse`: An issue related to Scheme Muse
- `Scheme [3] - Pisces`: An issue related to Scheme Pisces
- `Scheme [4] - Gemini`: An issue related to Scheme Gemini
- `3rd party service`: An issue related to 3rd party service
- `Docs`: Need to add instruction document
- `Configurations`: An issue related to configurations
- `CSS`: An issue related to CSS
- `Custom`: An issue related to custom things
- `Optimization`: An issue that needs to be optimized
- By results
- `Wontfix`: An issue that will not to be fixed
- `Need More Info`: Need more information for solving the issue
- `Need Confirm`: Need confirmation from the developers or user about the bug or solution
- `Can't Reproduce`: An issue that can’t be reproduced
- `Verified`: An issue that has been verified
- `Help wanted`: An issue that needs help
- `Wait for Answer`: An issue that needs to be answered by the developers or user
- `Resolved Maybe`: An issue that has been resolved maybe
- `Solved`: An issue that has been solved
- `Stale`: This issue has been automatically marked as stale because lack of recent activity

Pull requests related:

- `Breaking Change`: A Pull requests that makes breaking change
- `Bugfix`: A Pull requests that fixes the related bug
- `Docs`: A Pull requests that Instruction document has been added
- `Feature`: A Pull requests that provides a new feature
- `Configurations`: A Pull requests related to configurations
- `Optimization`: A Pull requests that optimizates the 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

### 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
Expand Down
55 changes: 55 additions & 0 deletions docs/zh-CN/CONTRIBUTING.md
Expand Up @@ -20,6 +20,7 @@

* [行为规范](#coding-rules)
* [编码规范](#coding-standards)
* [标签规范](#labels-rules)
* [提交信息规范](#commit-messages-rules)

<a name="how-can-i-contribute"></a>
Expand Down Expand Up @@ -123,6 +124,60 @@

未完待续。

<a name="labels-rules"></a>
### 标签规范

为了方便维护人员和用户能够快速找到他们想要查看的问题,我们使用“标签”功能对拉取请求和问题进行分类。

如果您不确定某个标签的含义,或者不知道将哪些标签应用于拉取请求或问题,千万别错过这个。

Issues 的标签:使用`类型`+`内容`+`结果`的组合

- 类型
- `Irrelevant`: 与主题 Next 无关的 Issue
- `Duplicate`: 已经存在同样 Issue
- `Bug`: 提出了 Bug,等待确认
- `Discussion`: 需要讨论的 Issue
- `Question`: 有关咨询的 Issue
- `Feature-Request`: 提出了特性需求的 Issue
- `Backlog`: 待解决的 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
- `3rd party service`: 与第三方服务相关的 Issue
- `Docs`: 需要添加文档说明的 Issue
- `Configurations`: 与主题 Next 设置相关的 Issue
- `CSS`: 与主题 Next CSS 文件相关的 Issue
- `Custom`: 与主题 Next 个性化相关的 Issue
- `Optimization`: 需要进行优化的 Issue
- 结果
- `Wontfix`: 不能或不被修复的 Issue
- `Need More Info`: 需要更多信息的 Issue
- `Need Confirm`: 需要开发人员或用户确认的 Issue
- `Can't Reproduce`: 不能被重现的 Issue
- `Verified`: 已经被确认的 Issue
- `Help wanted`: 需要帮助的 Issue
- `Wait for Answer`: 需要开发人员或用户回复的 Issue
- `Resolved Maybe`: 可能已经解决的 Issue
- `Solved`: 已经解决的 Issue
- `Stale`: 由于长期无人回应被封存的 Issue

Pull requests 的标签:

- `Breaking Change`: 涉及主题 Next 重大架构的 Pull request
- `Bugfix`: 修复 Bug 的 Pull request
- `Docs`: 添加了文档说明的 Pull request
- `Feature`: 添加了新特性的 Pull request
- `Configurations`: 涉及主题 Next 配置的 Pull request
- `Optimization`: 优化了主题 Next 的 Pull request
- `i18n`: 更新了翻译的 Pull request
- `Performance`: 提高了主题 Next 性能的 Pull request
- `Discussion`: 需要进行讨论的 Pull request

<a name="commit-messages-rules"></a>
### 提交信息规范

Expand Down

0 comments on commit c0852bb

Please sign in to comment.