|
| 1 | +Hello, and thanks for contributing to <%= name %>! |
| 2 | + |
| 3 | +## TL;DR |
| 4 | + |
| 5 | +There are three main goals in this document, depending on the nature of your PR: |
| 6 | + |
| 7 | +- [description](#description): tell us about your PR. |
| 8 | +- [checklist](#checklist): review the checklist that is most closely related to your PR. |
| 9 | +- [qa](#qa): update the qa checklist for your reviewers. |
| 10 | + |
| 11 | + |
| 12 | +## Title |
| 13 | +Add a clear title using an action verb. |
| 14 | +If it closes an issue, refer to it in your PR title by stating `closes #117` at the end. |
| 15 | + |
| 16 | +## Description |
| 17 | +To help others to quickly understand the nature of your pull request, please create a description that incorporates the following elements: |
| 18 | + |
| 19 | +- [] What is accomplished by the PR. |
| 20 | +- [] If you think some decisions may raise questions or require discussion, please state them and explain your choices. |
| 21 | + |
| 22 | + |
| 23 | +## Checklist |
| 24 | +Please use this checklist to verify that you took all the necessary steps. |
| 25 | + |
| 26 | +- [ ] If closing an issue, all acceptance criteria are met. |
| 27 | +- [ ] All existing unit tests are still passing. |
| 28 | +- [ ] Add new passing unit tests to cover the code introduced by your PR and maintain test coverage. |
| 29 | +- [ ] Update the readme if needed. |
| 30 | +- [ ] Update or add any necessary API documentation. |
| 31 | + |
| 32 | + |
| 33 | +## QA |
| 34 | +When your PR is created, it is important to select a reviewer with knowledge of the code that has been changed. |
| 35 | +It is also useful to guide reviewers, to this extent, please complete this QA list with areas that could be affected by your changes. |
| 36 | + |
| 37 | +Dear reviewer, please perform the following QA steps before approving my lovely PR: |
| 38 | +- [ ] The app loads nominally. |
| 39 | +- [ ] Select service area using the county selector. |
| 40 | +- [ ] Upload a service area csv (FIX DATASET). |
| 41 | +- [ ] Upload a provider csv (FIX DATASET). |
| 42 | +- [ ] Verify that `NEW FEATRURE` works as expected, i.e. `DETAILS`. |
0 commit comments