-
-
Notifications
You must be signed in to change notification settings - Fork 49k
PR principle
zombieJ edited this page Dec 29, 2018
·
5 revisions
[中文版]
- This principle is suitable for ant-design and ant-design-pro.
-
As current agreement, all the
new feature
must PR tofeature
branch. -
new feature
contains new feature added, obviously UI modification, interactive update, reconstruction, etc. -
feature
branch is locked and not allow push code directly. All the modification must use Pull Request. - Use follow PR template to submit feature related info.
- CI and other check tools pass.
- Modification must contains related changelog which contains truthful feedback to user, and also easy for releaser to check.
- Merge PR must get at least one another collaborator's approve.
- Daily bugfix, doc update, site maintain, branch merge is free for the principle.
- Ant Design official maintainers must comply with the principle. Other contributor can use PR template optional.
### This is a ...
[x] New feature
[ ] Other
### What's the background?
> 1. Describe the source of requirement.
> 2. Resolve what problem.
> 3. Related issue link.
### Realize of API
> 1. 基本的解决思路和其他可选方案。
> 2. 列出最终的 API 实现和用法。
> 3. 涉及UI/交互变动需要有截图或 GIF。
### 对用户的影响和可能的风险
> 1. 这个改动对用户端是否有影响?影响的方面有哪些?
> 2. 预期的 changelog 要怎么写?
> 3. 是否有可能隐含的 break change 和其他风险?
### 请求合并前的自查清单
- [x] 文档已补充或无须补充
- [x] 代码演示已提供或无须提供
- [x] TypeScript 定义已补充或无须补充
- [x] Changelog 已提供或无须提供
### 后续计划
> 如果这个提交后面还有相关的其他提交和跟进信息,可以写在这里。
- Home
- Cookbook
- FAQ
- Template for Bug Report in IE8 9
- Contributing
- Maintaining
- Design