diff --git a/squash-commits/PULL_REQUEST_TEMPLATE.md b/squash-commits/PULL_REQUEST_TEMPLATE.md index 954b051..027fc92 100644 --- a/squash-commits/PULL_REQUEST_TEMPLATE.md +++ b/squash-commits/PULL_REQUEST_TEMPLATE.md @@ -4,23 +4,23 @@ Please, go through these steps before you submit a PR. 1. Make sure that your PR is not a duplicate. 2. If not, then make sure that: - a. 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`. + a. 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`. - b. You have a descriptive commit message with a short title (first line). + b. You have a descriptive commit message with a short title (first line). - c. You have only one commit (if not, squash them into one commit). + c. You have only one commit (if not, squash them into one commit). - d. `npm test` doesn't throw any error. If it does, fix them first and amend your commit (`git commit --amend`). + d. `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. - a. Your pull request MUST NOT target the `master` branch on this repository. You probably want to target `staging` instead. + a. Your pull request MUST NOT target the `master` branch on this repository. You probably want to target `staging` instead. - b. Give a descriptive title to your PR. + b. Give a descriptive title to your PR. - c. Provide a description of your changes. + c. Provide a description of your changes. - d. Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if such). + d. 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.