From f9d3627143ea68d333061dc324f126cc6b605baa Mon Sep 17 00:00:00 2001 From: mfahadahmed Date: Tue, 6 Nov 2018 13:50:45 +0500 Subject: [PATCH 1/2] chore(contrib): Add PR template and commit message guidelines. --- CONTRIBUTING.md | 11 ++++++----- pull_request_template.md | 10 ++++++++++ 2 files changed, 16 insertions(+), 5 deletions(-) create mode 100644 pull_request_template.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4216ab55..832deaa0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,11 +4,12 @@ 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. `git push` your changes to GitHub. -4. Make sure that all unit tests are passing and that there are no merge conflicts between your branch and `master`. -5. Open a pull request from `YOUR_NAME/branch_name` to `master`. -6. A repository maintainer will review your pull request and, if all goes well, 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. `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, merge it! ## Pull request acceptance criteria diff --git a/pull_request_template.md b/pull_request_template.md new file mode 100644 index 00000000..0c40a606 --- /dev/null +++ b/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" From 3b9187aee948a5ec9f5527bf0a1b2b7956862806 Mon Sep 17 00:00:00 2001 From: mfahadahmed Date: Fri, 9 Nov 2018 13:07:36 +0500 Subject: [PATCH 2/2] Add repo forking guidelines. --- CONTRIBUTING.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 832deaa0..b23ae608 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,13 +3,14 @@ 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. `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, merge it! +5. Open a PR from your fork into the master branch of the original repo. +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