Pull Requests
To navigate to the PRs, use this link
All pull requests should follow a common template setup, they should also cover all criteria in the pull request checklist (unless otherwise specified).
- Latest master merged into your branch
- Tests covering all changes
- Meet the projects coding conventions
- No out of scope changes
- Reference the issue your pull request is related to, use a keyword so that the issue is automatically closed when the pull request is merged.
- Brief outline of changes and how you have solved the issue or implemented a feature.
- Any specific notes for reviewers (e.g. if you require testing on a different OS)
Pull requests require a minimum of one person to review. When the person reviewing approves the changes, it is their job to merge the PR into master.
To checkout the pull request locally, use the following command to checkout the pull request branch locally:
git fetch origin pull/PULL_REQUEST_NUMBER/head:BRANCH_NAME
NOTE: To all reviewers, once you have merged the changes into master delete the branch these features came from. This keeps forks clean and prevents branches being dragged out of scope.
If your changes cannot be tested programmatically, add steps below so that the reviewer can manually tests your changes. Otherwise, list the names of the new unit tests you have added to the test suite.
Steps for manual testing:
- ...
- ...
Newly added unit tests:
- List the names of tests you've added to the test suite
- [] Latest master merged/rebased into your feature branch
- [] Tests covering all changes
- [] Meets the projects coding conventions
- [] No out of scope changes
- [] @Mentioned any relevant team members
- [] No failure when running the linter (
npm run lint) - [] Included a relevant gif (search here for inspiration)
- Include description/related issue number as required
- Put 'x' in the box if you have done it, or a space between the braces if you haven't done it.
- Include gif, and submit!
Note: If you're the code author in the PR. Once your code has been approved and merged, the branch the feature was developed on is to be deleted.