diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..0c40a6068 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,10 @@ +## Summary +- The "what"; a concise description of each logical change +- Another change + +The "why", or other context. + +## Test plan + +## Issues +- "THING-1234" or "Fixes #123" diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f84665da7..5d8b1dd19 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,13 +4,15 @@ We welcome contributions and feedback! All contributors must sign our [Contribut ## Development process -1. Create a branch off of `master`: `git checkout -b YOUR_NAME/branch_name`. -2. Commit your changes. Make sure to add tests! -3. Run `npm run lint` to ensure there are no lint errors. -4. `git push` your changes to GitHub. -5. Make sure that all unit tests are passing and that there are no merge conflicts between your branch and `master`. -6. Open a pull request from `YOUR_NAME/branch_name` to `master`. -7. A repository maintainer will review your pull request and, if all goes well, squash and merge it! +1. Fork the repository and create your branch from master. +2. Please follow the [commit message guidelines](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines) for each commit message. +3. Make sure to add tests! +4. Run `npm run lint` to ensure there are no lint errors. +5. `git push` your changes to GitHub. +6. Open a PR from your fork into the master branch of the original repo +7. Make sure that all unit tests are passing and that there are no merge conflicts between your branch and `master`. +8. Open a pull request from `YOUR_NAME/branch_name` to `master`. +9. A repository maintainer will review your pull request and, if all goes well, squash and merge it! ## Pull request acceptance criteria