rt-thread-official/.github/PULL_REQUEST_TEMPLATE.md

65 lines
3.6 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-13 11:28:50 +08:00
[
2022-11-01 11:36:04 +08:00
<!-- 这段方括号里的内容是您**必须填写并替换掉**的否则PR不可能被合并。**方括号外面的内容不需要修改,但请仔细阅读。**
2020-10-11 18:46:18 +08:00
The content in this square bracket must be filled in and replaced, otherwise, PR can not be merged. The contents outside square brackets need not be changed, but please read them carefully.
2019-01-02 11:11:20 +08:00
2019-01-13 11:28:50 +08:00
请在这里填写您的PR描述可以包括以下之一的内容为什么提交这份PR解决的问题是什么你的解决方案是什么
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;
并确认并列出已经在什么情况或板卡上进行了测试。
2022-11-01 11:36:04 +08:00
And confirm in which case or board has been tested. -->
#### 为什么提交这份PR (why to submit this PR)
#### 你的解决方案是什么 (what is your solution)
2023-11-15 18:17:01 +08:00
#### 请提供验证的bsp和config (provide the config and bsp)
<!-- 请填写验证bsp目录下面的目录比如bsp/stm32/stm32l496-st-nucleo
2023-11-15 18:17:01 +08:00
Please provide the path of verfied bsp. Like bsp/stm32/stm32l496-st-nucleo bsp/ESP32_C3 -->
2023-11-15 18:17:01 +08:00
- BSP:
<!-- 请填写.config 文件中需要改动的config
2023-11-15 18:17:01 +08:00
Please provide the changed config of .config file to how to verify the PR file like CONFIG_BSP_USING_I2C CONFIG_BSP_USING_WDT -->
2023-11-15 18:17:01 +08:00
- .config:
<!-- 请提供自己仓库的PR branch的action的编译链接相关PR文件成功的链接
2023-11-15 18:17:01 +08:00
Please provide the link of action triggered by your own repo's action
https://github.com/RT-Thread/rt-thread/actions/workflows/manual_dist.yml -->
2023-11-15 18:17:01 +08:00
- action:
2022-11-01 11:36:04 +08:00
2019-01-13 11:28:50 +08:00
]
2019-01-02 11:11:20 +08:00
2022-11-01 11:36:04 +08:00
<!-- 以下的内容不应该在提交PR时的message修改修改下述messagePR会被直接关闭。请在提交PR后浏览器查看PR并对以下检查项逐项check没问题后逐条在页面上打钩。
The following content must not be changed in the submitted PR message. Otherwise, the PR will be closed immediately. After submitted PR, please use a web browser to visit PR, and check items one by one, and ticked them if 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
2020-10-11 18:46:18 +08:00
- [ ] 代码风格正确,包括缩进空格,命名及其他风格 Style guide is adhered to, including spacing, naming and other styles
2019-01-10 10:55:41 +08:00
- [ ] 没有垃圾代码,代码尽量精简,不包含`#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
2022-11-01 11:36:04 +08:00
- [ ] 代码是高质量的 Code in this PR is of high quality
- [ ] 已经使用[formatting](https://github.com/mysterywolf/formatting) 等源码格式化工具确保格式符合[RT-Thread代码规范](https://github.com/RT-Thread/rt-thread/blob/master/documentation/contribution_guide/coding_style_cn.md) This PR complies with [RT-Thread code specification](https://github.com/RT-Thread/rt-thread/blob/master/documentation/contribution_guide/coding_style_en.md)