gaspersic/freeCodeCamp
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #7190 from firstdoit/fix/pr-template-details

Browse Source 
Improve PR template with details from CONTRIBUTING
This commit is contained in:
Logan Tegman
2016-03-02 10:34:16 -08:00
parent 052523f084 670d8f1dbe
commit 1065fd6c04
1 changed files with 15 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@ -1,21 +1,27 @@
## FreeCodeCamp Pull Request template
Please, go through steps before you submit a PR.
Please, go through these steps before you submit a PR.
1. Make sure that your PR is not a duplicate.
2. If not then:
2. If not, then make sure that:
2.1. Make sure you've done your changes in a separate branch, like `fix/signin-issue` or `feature/issue-templates`.
2.1. You have done your changes in a separate branch. Branches MUST have descriptive names that start with either the `fix/` or `feature/` prefixes. Good examples are: `fix/signin-issue` or `feature/issue-templates`.
2.2. You have a descriptive commit message.
2.2. You have a descriptive commit message with a short title (first line).
2.3. You have only one commit (if not, [squash](https://github.com/FreeCodeCamp/FreeCodeCamp/wiki/git-rebase#squashing-multiple-commits-into-one) them into one commit).
2.4. Make sure `npm test` doesn't throw any error. If it does, fix them first and amend your commit.
2.4. `npm test` doesn't throw any error. If it does, fix them first and amend your commit (`git commit --amend`).
3. **After** these steps you're ready to open a pull request. ***Don't*** forget to remove this template first.
3. **After** these steps, you're ready to open a pull request.
3.1. Give a descriptive title to your PR.
3.1. Your pull request MUST NOT target the `master` branch on FreeCodeCamp's repository. You probably want to target `staging` instead.
3.2. Provide a description of your changes.
3.2. Give a descriptive title to your PR.
3.3. Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if such).
3.3. Provide a description of your changes.
3.4. Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if such).
IMPORTANT: Please review the [CONTRIBUTING.md](../CONTRIBUTING.md) file for detailed contributing guidelines.
**PLEASE REMOVE THIS TEMPLATE BEFORE SUBMITTING**