diff options
| author | ClementTsang <cjhtsang@uwaterloo.ca> | 2021-05-22 22:58:16 -0400 |
|---|---|---|
| committer | ClementTsang <cjhtsang@uwaterloo.ca> | 2021-05-22 22:58:16 -0400 |
| commit | b03c53d1efcc556b338e02327f9066439faed9fa (patch) | |
| tree | 16b89d755215a1a7f872557f57922667d570e2b2 /.github | |
| parent | 6847f2ff0ce5827c0779a1dfcb9e6a8a657652b1 (diff) | |
github: update PR template
Diffstat (limited to '.github')
| -rw-r--r-- | .github/pull_request_template.md | 31 |
1 files changed, 7 insertions, 24 deletions
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index ec5e425e..16a03ae8 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -8,39 +8,22 @@ _If applicable, what issue does this address?_ Closes: # -## Type of change +## Testing -_Remove the irrelevant ones:_ +_If relevant, please state how this was tested. All changes **must** be tested to work:_ -- [x] _Bug fix (non-breaking change which fixes an issue)_ -- [x] _New feature (non-breaking change which adds functionality)_ -- [x] _Breaking change (if this change causes breakage or new behaviour, please state what)_ -- [x] _Refactoring (a change that doesn't change application functionality)_ -- [x] _Other (something else - please specify)_ - -## Test methodology - -_If relevant, please state how this was tested:_ - -_Furthermore, please tick which platforms this change was tested on:_ +_Furthermore, mark which platforms this change was tested on. All platforms directly affected by the change **must** be tested_ - [ ] _Windows_ - [ ] _macOS_ - [ ] _Linux_ -_If relevant, all of these platforms should be tested._ - ## Checklist _If relevant, ensure the following have been met:_ -- [ ] _Change has been tested to work, and does not cause new breakage unless intended_ -- [ ] _Code has been self-reviewed_ -- [ ] _Documentation has been added/updated if needed (README, help menu, etc.)_ -- [ ] _Passes CI pipeline (clippy check and `cargo test` check)_ - [ ] _Areas your change affects have been linted using rustfmt (`cargo fmt`)_ -- [ ] _No merge conflicts arise from the change_ - -## Other information - -_Provide any other relevant information to this change:_ +- [ ] _The change has been tested and doesn't appear to cause any unintended breakage_ +- [ ] _Documentation has been added/updated if needed (README, help menu, etc.)_ +- [ ] _The pull request passes the provided CI pipeline_ +- [ ] _There are no merge conflicts_ |