diff --git a/.github/PULL_REQUEST_TEMPLATE/collaborator.md b/.github/PULL_REQUEST_TEMPLATE/collaborator.md new file mode 100644 index 0000000000..258332b2bb --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/collaborator.md @@ -0,0 +1,33 @@ +### This is a ... + +- [ ] 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 + +- [ ] Doc is ready or not need +- [ ] Demo is provided or not need +- [ ] TypeScript definition is ready or not need +- [ ] Changelog provided + +### Additional Plan? + +> If this PR related with other PR or following info. You can type here. diff --git a/README.md b/README.md index 7c3be52957..e302548d07 100644 --- a/README.md +++ b/README.md @@ -110,4 +110,6 @@ Read our [contributing guide](https://ant.design/docs/react/contributing) and le We welcome all contributions. Please read our [CONTRIBUTING.md](https://github.com/ant-design/ant-design/blob/master/.github/CONTRIBUTING.md) first. You can submit any ideas as [pull requests](https://github.com/ant-design/ant-design/pulls) or as [GitHub issues](https://github.com/ant-design/ant-design/issues). If you'd like to improve code, check out the [Development Instructions](https://github.com/ant-design/ant-design/wiki/Development) and have a good time! :) +If you are collaborator. Please follow our [Pull Request principle](https://github.com/ant-design/ant-design/wiki/PR-principle) to create Pull Request by [collaborator template](https://github.com/ant-design/ant-design/compare?expand=1&template=collaborator.md). + [![Let's fund issues in this repository](https://issuehunt.io/static/embed/issuehunt-button-v1.svg)](https://issuehunt.io/repos/34526884)