rt-thread/.github/PULL_REQUEST_TEMPLATE.md

36 lines
1.6 KiB
Markdown
Raw Normal View History

2019-01-02 13:11:13 +08:00
### Summary of this Pull Request (PR) 拉取/合并请求的简述
2019-01-02 11:11:20 +08:00
2019-01-02 13:11:13 +08:00
**Add description here.** **请在这里加入描述**
2019-01-02 11:11:20 +08:00
2019-01-02 13:11:13 +08:00
### Intent for your PR 拉取/合并请求的目的
2019-01-02 11:11:20 +08:00
2019-01-02 11:19:13 +08:00
Choose one (Mandatory): 必须选择一项
2019-01-02 11:11:20 +08:00
2019-01-02 13:11:13 +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
### Reviewers (Mandatory): 代码审阅者(必须指定)
2019-01-02 13:11:13 +08:00
(@<github.com username(s)> Ex: @user1, @user2)
2019-01-02 11:11:20 +08:00
### Code Quality 代码质量
2019-01-02 13:11:13 +08:00
2019-01-02 11:11:20 +08:00
As part of this pull request, I've considered the following:
2019-01-02 13:11:13 +08:00
我在这个拉取/合并请求中已经考虑了:
- [ ] Already check the difference between PR and old code 已经仔细查看过代码改动的对比
- [ ] Style guide is adhered to, including spacing, naming and other style 代码风格正确,包括缩进空格,命名及其他风格
- [ ] All redundant code is removed and cleaned up 没有垃圾代码,代码尽量精简,不包含`#if 0`代码,不包含已经被注释了的代码
- [ ] All modifications are justified and not affect other components or BSP 所有变更均有原因及合理的并且不会影响到其他软件组件代码或BSP
- [ ] I've commented appropriately where code is tricky 对难懂代码均提供对应的注释
- [ ] Code in this PR is of high quality 本拉取/合并请求代码是高质量的
2019-01-02 11:11:20 +08:00
### Testing代码测试
I've tested the code using the following test programs (provide list here):
2019-01-02 13:11:13 +08:00
我已经在如下场合跑过对应的测试:
2019-01-02 11:11:20 +08:00
- [ ] application 1
- [ ] application 2
- [ ] ...(add others here)