From bc8b59d8f084199452e12485f8a34886c0068c0e Mon Sep 17 00:00:00 2001 From: Mike Ng Date: Mon, 5 Nov 2018 12:07:04 -0800 Subject: [PATCH 1/2] chore(contrib): Add PR template and commit message guidelines. --- .github/pull_request_template.md | 10 ++++++++++ CONTRIBUTING.md | 13 +++++++------ 2 files changed, 17 insertions(+), 6 deletions(-) create mode 100644 .github/pull_request_template.md 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..28d449b85 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,12 +5,13 @@ 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! +2. Commit your changes. We follow the [commit message guidelines](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines) from Angular. +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. Make sure that all unit tests are passing and that there are no merge conflicts between your branch and `master`. +7. Open a pull request from `YOUR_NAME/branch_name` to `master`. +8. A repository maintainer will review your pull request and, if all goes well, squash and merge it! ## Pull request acceptance criteria From aef9d22f2e8cc5d57775ed6270b10a55a2f28f60 Mon Sep 17 00:00:00 2001 From: Mike Ng Date: Tue, 6 Nov 2018 08:50:17 -0800 Subject: [PATCH 2/2] chore: Add notes about forking the repo. --- CONTRIBUTING.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 28d449b85..5d8b1dd19 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,14 +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. We follow the [commit message guidelines](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines) from Angular. +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. Make sure that all unit tests are passing and that there are no merge conflicts between your branch and `master`. -7. Open a pull request from `YOUR_NAME/branch_name` to `master`. -8. A repository maintainer will review your pull request and, if all goes well, squash and merge it! +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