summaryrefslogtreecommitdiffstats
path: root/.github
diff options
context:
space:
mode:
authorClement Tsang <34804052+ClementTsang@users.noreply.github.com>2020-04-28 22:51:18 -0400
committerGitHub <noreply@github.com>2020-04-28 22:51:18 -0400
commitb6ea10770b6784f7aff634a8fdf487f9f21798d4 (patch)
treec3c40dd0bfa1b189e0abcfc15cdd8a02566215b7 /.github
parent554505b221ae385769f6b5534bf03d5f0f3e8a11 (diff)
github: update PR template
Diffstat (limited to '.github')
-rw-r--r--.github/pull_request_template.md12
1 files changed, 7 insertions, 5 deletions
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 8fb322be..1ad95560 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -14,14 +14,15 @@ _Remove the irrelevant ones:_
- [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] _Other (something else - please specify if relevant):_
+- [x] _Breaking change (if this change causes breakage or new behaviour, please state what)_
+- [x] _Refactoring (some change that doesn't change functionality; if relevant state what was changed)_
+- [x] _Other (something else - please specify if relevant)_
## Test methodology
-_Please state how this was tested:_
+_If required, please state how this was tested:_
-_Please tick which platforms this change was tested on:_
+_Furthermore, please tick which platforms this change was tested on:_
- [ ] _Windows_
- [ ] _macOS_
@@ -29,12 +30,13 @@ _Please tick which platforms this change was tested on:_
## Checklist
-_Please ensure all are ticked (and actually done):_
+_If relevant, see if the following have been met:_
- [ ] _Change has been tested to work_
- [ ] _Areas your change affects have been linted using rustfmt_
- [ ] _Code has been self-reviewed_
- [ ] _Code has been tested and no new breakage is introduced unless intended_
+- [ ] _Passes CI tests_
- [ ] _Documentation has been added/updated if needed_
- [ ] _No merge conflicts arise from the change_