Skip to content

Commit 1871308

Browse files
committed
docs: add pr template
1 parent 8244780 commit 1871308

File tree

2 files changed

+105
-0
lines changed

2 files changed

+105
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
First of all, thank you for your contribution! 😄
2+
3+
New feature please send pull request to feature branch, and rest to master branch.
4+
Pull request will be merged after one of collaborators approve.
5+
Please makes sure that these form are filled before submitting your pull request, thank you!
6+
7+
[[中文版模板 / Chinese template](https://github.com/vueComponent/ant-design-vue/blob/master/.github/PULL_REQUEST_TEMPLATE/pr_cn.md)]
8+
9+
### This is a ...
10+
11+
- [ ] New feature
12+
- [ ] Bug fix
13+
- [ ] Site / document update
14+
- [ ] Component style update
15+
- [ ] TypeScript definition update
16+
- [ ] Refactoring
17+
- [ ] Code style optimization
18+
- [ ] Branch merge
19+
- [ ] Other (about what?)
20+
21+
### What's the background?
22+
23+
> 1. Describe the source of requirement.
24+
> 2. Resolve what problem.
25+
> 3. Related issue link.
26+
27+
### API Realization (Optional if not new feature)
28+
29+
> 1. Basic thought of solution and other optional proposal.
30+
> 2. List final API realization and usage sample.
31+
> 3. GIF or snapshot should be provided if includes UI/interactive modification.
32+
33+
### What's the effect? (Optional if not new feature)
34+
35+
> 1. Does this PR affect user? Which part will be affected?
36+
> 2. What will say in changelog?
37+
> 3. Does this PR contains potential break change or other risk?
38+
39+
### Changelog description (Optional if not new feature)
40+
41+
> 1. English description
42+
> 2. Chinese description (optional)
43+
44+
### Self Check before Merge
45+
46+
- [ ] Doc is updated/provided or not needed
47+
- [ ] Demo is updated/provided or not needed
48+
- [ ] TypeScript definition is updated/provided or not needed
49+
- [ ] Changelog is provided or not needed
50+
51+
### Additional Plan? (Optional if not new feature)
52+
53+
> If this PR related with other PR or following info. You can type here.
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
首先,感谢你的贡献! 😄
2+
3+
新特性请提交至 feature 分支,其余可提交至 master 分支。
4+
在一个维护者审核通过后合并。
5+
请确保填写以下 pull request 的信息,谢谢!~
6+
7+
[[English Template / 英文模板](?expand=1)]
8+
9+
### 这个变动的性质是
10+
11+
- [ ] 新特性提交
12+
- [ ] 日常 bug 修复
13+
- [ ] 站点、文档改进
14+
- [ ] 组件样式改进
15+
- [ ] TypeScript 定义更新
16+
- [ ] 重构
17+
- [ ] 代码风格优化
18+
- [ ] 分支合并
19+
- [ ] 其他改动(是关于什么的改动?)
20+
21+
### 需求背景
22+
23+
> 1. 描述相关需求的来源。
24+
> 2. 要解决的问题。
25+
> 3. 相关的 issue 讨论链接。
26+
27+
### 实现方案和 API(非新功能可选)
28+
29+
> 1. 基本的解决思路和其他可选方案。
30+
> 2. 列出最终的 API 实现和用法。
31+
> 3. 涉及UI/交互变动需要有截图或 GIF。
32+
33+
### 对用户的影响和可能的风险(非新功能可选)
34+
35+
> 1. 这个改动对用户端是否有影响?影响的方面有哪些?
36+
> 2. 是否有可能隐含的 break change 和其他风险?
37+
38+
### Changelog 描述(非新功能可选)
39+
40+
> 1. 英文描述
41+
> 2. 中文描述(可选)
42+
43+
### 请求合并前的自查清单
44+
45+
- [ ] 文档已补充或无须补充
46+
- [ ] 代码演示已提供或无须提供
47+
- [ ] TypeScript 定义已补充或无须补充
48+
- [ ] Changelog 已提供或无须提供
49+
50+
### 后续计划(非新功能可选)
51+
52+
> 如果这个提交后面还有相关的其他提交和跟进信息,可以写在这里。

0 commit comments

Comments
 (0)