rt-thread/.github/PULL_REQUEST_TEMPLATE.md

29 lines
1.9 KiB
Markdown
Raw Normal View History

2019-01-10 10:55:41 +08:00
## 拉取/合并请求描述:(PR description)
2019-01-02 11:11:20 +08:00
2019-01-10 10:55:41 +08:00
请仔细阅读以下文字。请在这里填写您的PR描述可以包括以下之一的内容为什么提交这份PR解决的问题是什么你的解决方案是什么
Please read the following carefully. Please fill in your PR description here, which can include one of the following items: why to submit this PR; what is the problem solved and what is your solution;
2019-01-02 11:11:20 +08:00
2019-01-10 10:55:41 +08:00
并确认已经在什么情况或板卡上进行了测试。
And confirm in which case or board have been tested.
2019-01-02 11:11:20 +08:00
2019-01-10 10:55:41 +08:00
以下的内容请在提交PR后一项项进行check没问题后逐条在页面上打钩。
The following contents should be checked item by item after submitted PR, and ticked on the browser one by one after no problem.
2019-01-02 11:11:20 +08:00
2019-01-10 10:55:41 +08:00
### 当前拉取/合并请求的状态 Intent for your PR
2019-01-02 11:11:20 +08:00
2019-01-10 10:55:41 +08:00
必须选择一项 Choose one (Mandatory):
2019-01-02 11:11:20 +08:00
2019-01-10 10:55:41 +08:00
- [ ] 本拉取/合并请求是一个草稿版本 This PR is for a code-review and is intended to get feedback
- [ ] 本拉取/合并请求是一个成熟版本 This PR is mature, and ready to be integrated into the repo
2019-01-02 11:11:20 +08:00
2019-01-10 10:55:41 +08:00
### 代码质量 Code Quality
2019-01-02 13:11:13 +08:00
2019-01-10 10:55:41 +08:00
我在这个拉取/合并请求中已经考虑了 As part of this pull request, I've considered the following:
2019-01-02 13:11:13 +08:00
2019-01-10 10:55:41 +08:00
- [ ] 已经仔细查看过代码改动的对比 Already check the difference between PR and old code
- [ ] 代码风格正确,包括缩进空格,命名及其他风格 Style guide is adhered to, including spacing, naming and other style
- [ ] 没有垃圾代码,代码尽量精简,不包含`#if 0`代码,不包含已经被注释了的代码 All redundant code is removed and cleaned up
- [ ] 所有变更均有原因及合理的并且不会影响到其他软件组件代码或BSP All modifications are justified and not affect other components or BSP
- [ ] 对难懂代码均提供对应的注释 I've commented appropriately where code is tricky
- [ ] 本拉取/合并请求代码是高质量的 Code in this PR is of high quality