-
-
Notifications
You must be signed in to change notification settings - Fork 49.8k
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 (But still update through PR for trace).
- 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.
### API Realization
> 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 affect?
> 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?
### Self Check before Merge
- [x] Doc is ready or not need
- [x] Demo is provided or not need
- [x] TypeScript definition is ready or not need
- [x] Changelog provided
### Additional Plan?
> If this PR related with other PR or following info. You can type here.
- Home
- Cookbook
- FAQ
- Template for Bug Report in IE8 9
- Contributing
- Maintaining
- Design