ant-design/.github/PULL_REQUEST_TEMPLATE.md

47 lines
1.4 KiB
Markdown
Raw Normal View History

First of all, thank you for your contribution! 😄
2016-02-23 09:43:21 +08:00
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!
2016-02-23 09:43:21 +08:00
[[中文版模板 / Chinese template](https://github.com/ant-design/ant-design/blob/master/.github/PULL_REQUEST_TEMPLATE/pr_cn.md)]
2017-06-13 14:38:34 +08:00
### 🤔 This is a ...
2017-06-13 14:38:34 +08:00
- [ ] New feature
- [ ] Bug fix
- [ ] Site / document update
2019-01-08 20:41:02 +08:00
- [ ] Component style update
- [ ] TypeScript definition update
- [ ] Refactoring
- [ ] Code style optimization
- [ ] Branch merge
- [ ] Other (about what?)
2017-06-13 14:38:34 +08:00
2019-03-04 22:30:19 +08:00
### 👻 What's the background?
1. Describe the source of requirement, like related issue link.
2019-01-29 12:01:52 +08:00
2019-03-04 22:30:19 +08:00
2. Describe the problem and the scenario.
### 💡 Solution
2019-03-04 22:30:19 +08:00
1. How to fix the problem, and list final API implementation and usage sample if that is an new feature.
2017-06-13 14:38:34 +08:00
2. GIF or snapshot should be provided if includes UI/interactive modification.
2017-06-13 14:38:34 +08:00
### 📝 Changelog description
> Describe changes from user side, and list all potential break changes or other risks.
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