From 95a1db61d68e11b015d02cd0fdea5808fcfa9344 Mon Sep 17 00:00:00 2001 From: Bernard Xiong Date: Thu, 10 Jan 2019 10:55:41 +0800 Subject: [PATCH] Update PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 45 ++++++++++++++------------------ 1 file changed, 19 insertions(+), 26 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index c1e467e6c4..a82fe6a2bf 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,35 +1,28 @@ -### Summary of this Pull Request (PR) 拉取/合并请求的简述 +## 拉取/合并请求描述：(PR description) -**Add description here.** **请在这里加入描述** +请仔细阅读以下文字。请在这里填写您的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; -### Intent for your PR 拉取/合并请求的目的 +并确认已经在什么情况或板卡上进行了测试。 +And confirm in which case or board have been tested. -Choose one (Mandatory): 必须选择一项 +以下的内容请在提交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. -- [ ] 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 本拉取/合并请求是一个成熟版本 +### 当前拉取/合并请求的状态 Intent for your PR -### Reviewers (Mandatory): 代码审阅者（必须指定） +必须选择一项 Choose one (Mandatory): -(@ Ex: @user1, @user2) +- [ ] 本拉取/合并请求是一个草稿版本 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 -### Code Quality： 代码质量 +### 代码质量 Code Quality： -As part of this pull request, I've considered the following: -我在这个拉取/合并请求中已经考虑了： +我在这个拉取/合并请求中已经考虑了 As part of this pull request, I've considered the following: -- [ ] 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 本拉取/合并请求代码是高质量的 - -### Testing：代码测试 - -I've tested the code using the following test programs (provide list here): -我已经在如下场合跑过对应的测试： - -- [ ] application 1 -- [ ] application 2 -- [ ] ...(add others here) +- [ ] 已经仔细查看过代码改动的对比 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