Browse Source

📝 make pull request template more practical

pull/15148/head
afc163 6 years ago
parent
commit
1363a5e0f0
No known key found for this signature in database GPG Key ID: 738F973FCE5C6B48
  1. 35
      .github/PULL_REQUEST_TEMPLATE.md
  2. 36
      .github/PULL_REQUEST_TEMPLATE/pr_cn.md

35
.github/PULL_REQUEST_TEMPLATE.md

@ -6,7 +6,7 @@ Please makes sure that these form are filled before submitting your pull request
[[中文版模板 / Chinese template](https://github.com/ant-design/ant-design/blob/master/.github/PULL_REQUEST_TEMPLATE/pr_cn.md)]
### This is a ...
### 🤔 This is a ...
- [ ] New feature
- [ ] Bug fix
@ -18,36 +18,29 @@ Please makes sure that these form are filled before submitting your pull request
- [ ] Branch merge
- [ ] Other (about what?)
### What's the background?
### 👻 What's the background and how to resolve it?
> 1. Describe the source of requirement.
> 2. Resolve what problem.
> 3. Related issue link.
1. Describe the source of requirement, like related issue link.
### API Realization (Optional if not new feature)
2. Describe the existed solution.
> 1. Basic thought of solution and other optional proposal.
> 2. List final API realization and usage sample.
> 3. GIF or snapshot should be provided if includes UI/interactive modification.
### 💡 Solution
### What's the effect? (Optional if not new feature)
1. List final API implementation and usage sample.
> 1. Does this PR affect user? Which part will be affected?
> 2. What will say in changelog?
> 3. Does this PR contains potential break change or other risk?
2. GIF or snapshot should be provided if includes UI/interactive modification.
### Changelog description (Optional if not new feature)
### 📝 Changelog description
> 1. English description
> 2. Chinese description (optional)
> Describe changes from user side, and list all potential break changes or other risks.
### Self Check before Merge
1. English description
2. Chinese description (optional)
### ☑️ Self Check before Merge
- [ ] Doc is updated/provided or not needed
- [ ] Demo is updated/provided or not needed
- [ ] TypeScript definition is updated/provided or not needed
- [ ] Changelog is provided or not needed
### Additional Plan? (Optional if not new feature)
> If this PR related with other PR or following info. You can type here.

36
.github/PULL_REQUEST_TEMPLATE/pr_cn.md

@ -1,4 +1,4 @@
首先,感谢你的贡献! 😄
首先,感谢你的贡献!😄
新特性请提交至 feature 分支,其余可提交至 master 分支。
在一个维护者审核通过后合并。
@ -6,7 +6,7 @@
[[English Template / 英文模板](?expand=1)]
### 这个变动的性质是
### 🤔 这个变动的性质是
- [ ] 新特性提交
- [ ] 日常 bug 修复
@ -18,35 +18,29 @@
- [ ] 分支合并
- [ ] 其他改动(是关于什么的改动?)
### 需求背景
### 👻 需求背景
> 1. 描述相关需求的来源。
> 2. 要解决的问题。
> 3. 相关的 issue 讨论链接。
1. 描述相关需求的来源,如相关的 issue 讨论链接。
### 实现方案和 API(非新功能可选)
2. 要解决的具体问题。
> 1. 基本的解决思路和其他可选方案。
> 2. 列出最终的 API 实现和用法。
> 3. 涉及UI/交互变动需要有截图或 GIF。
### 💡 解决方案和最终实现是?
### 对用户的影响和可能的风险(非新功能可选)
1. 列出最终的 API 实现和用法。
> 1. 这个改动对用户端是否有影响?影响的方面有哪些?
> 2. 是否有可能隐含的 break change 和其他风险?
2. 涉及UI/交互变动需要有截图或 GIF。
### Changelog 描述(非新功能可选)
### 📝 更新日志怎么写?
> 1. 英文描述
> 2. 中文描述(可选)
> 从用户角度描述具体变化,以及可能的 breaking change 和其他风险?
### 请求合并前的自查清单
1. 英文描述
2. 中文描述(可选)
### ☑️ 请求合并前的自查清单
- [ ] 文档已补充或无须补充
- [ ] 代码演示已提供或无须提供
- [ ] TypeScript 定义已补充或无须补充
- [ ] Changelog 已提供或无须提供
### 后续计划(非新功能可选)
> 如果这个提交后面还有相关的其他提交和跟进信息,可以写在这里。

Loading…
Cancel
Save