From fb46e014f0b8190771b9b323a8682938ff9efa5a Mon Sep 17 00:00:00 2001 From: zombieJ Date: Mon, 7 Jan 2019 09:28:00 +0800 Subject: [PATCH] Update PR template (#14125) * update template * add branch desc --- .github/PULL_REQUEST_TEMPLATE.md | 20 +++++++++++++----- .github/PULL_REQUEST_TEMPLATE/pr_cn.md | 29 +++++++++++++++++--------- 2 files changed, 34 insertions(+), 15 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 59eff5965a..1ce93bd735 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,41 +1,51 @@ First of all, thank you for your contribution! 😄 +New feature please send pull request to feature branch, and rest to master branch. +Pull request will be merged after one of collaborators approve. Please makes sure that these form are filled before submitting your pull request, thank you! -[[中文版](https://github.com/ant-design/ant-design/blob/master/.github/PULL_REQUEST_TEMPLATE/pr_cn.md)] +[[中文版模板 / Chinese template](https://github.com/ant-design/ant-design/blob/master/.github/PULL_REQUEST_TEMPLATE/pr_cn.md)] ### This is a ... - [ ] New feature - [ ] Bug fix - [ ] Site / document update +- [ ] TypeScript definition update +- [ ] Refactoring +- [ ] Code style optimization - [ ] Branch merge - [ ] Other (about what?) ### What's the background? - + > 1. Describe the source of requirement. > 2. Resolve what problem. > 3. Related issue link. ### API Realization (Optional if not new feature) - + > 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. - + ### What's the effect? (Optional if not new feature) > 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? +### Changelog description (Optional if not new feature) + +> 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 provided +- [ ] Changelog is provided or not needed ### Additional Plan? (Optional if not new feature) diff --git a/.github/PULL_REQUEST_TEMPLATE/pr_cn.md b/.github/PULL_REQUEST_TEMPLATE/pr_cn.md index 949d22d389..17618fab3c 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pr_cn.md +++ b/.github/PULL_REQUEST_TEMPLATE/pr_cn.md @@ -1,34 +1,43 @@ -首先，感谢你的贡献！😄 +首先，感谢你的贡献！ 😄 +新特性请提交至 feature 分支，其余可提交至 master 分支。 +在一个维护者审核通过后合并。 请确保填写以下 pull request 的信息，谢谢！~ -[[English Version](?expand=1)] +[[English Template / 英文模板](?expand=1)] ### 这个变动的性质是 - [ ] 新特性提交 - [ ] 日常 bug 修复 - [ ] 站点、文档改进 +- [ ] TypeScript 定义更新 +- [ ] 重构 +- [ ] 代码风格优化 - [ ] 分支合 - [ ] 其他改动（是关于什么的改动？） ### 需求背景 - + > 1. 描述相关需求的来源。 > 2. 要解决的问题。 > 3. 相关的 issue 讨论链接。 - -### 实现方案和 API + +### 实现方案和 API（非新功能可选） > 1. 基本的解决思路和其他可选方案。 > 2. 列出最终的 API 实现和用法。 > 3. 涉及UI/交互变动需要有截图或 GIF。 - -### 对用户的影响和可能的风险 + +### 对用户的影响和可能的风险（非新功能可选） > 1. 这个改动对用户端是否有影响？影响的方面有哪些？ -> 2. 预期的 changelog 要怎么写？ -> 3. 是否有可能隐含的 break change 和其他风险？ +> 2. 是否有可能隐含的 break change 和其他风险？ + +### Changelog 描述（非新功能可选） + +> 1. 英文描述 +> 2. 中文描述（可选） ### 请求合并前的自查清单 @@ -37,6 +46,6 @@ - [ ] TypeScript 定义已补充或无须补充 - [ ] Changelog 已提供或无须提供 -### 后续计划 +### 后续计划（非新功能可选） > 如果这个提交后面还有相关的其他提交和跟进信息，可以写在这里。