diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 67007c31..4dd60977 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,30 +1,39 @@ + + ## Description -_A description of the change, what it does, and why it was made. If relevant (such as any change that modifies the UI), **please provide screenshots** of the changes:_ +_A description of the change, what it does, and why it was made:_ + +_If relevant (such as any change that modifies the UI), **please provide screenshots or recordings** of the changes:_ ## Issue _If applicable, what issue does this address?_ -Closes: # +Closes: # ## Testing -_If relevant, please state how this was tested. All changes **must** be tested to work:_ +_If relevant, please state how this was tested (including steps if necessary):_ -_If this is a code change, please also indicate which platforms were tested:_ +_If this change affects the program, please also indicate which platforms were tested:_ - [ ] _Windows_ - [ ] _macOS_ -- [ ] _Linux_ +- [ ] _Linux (specify distro below)_ ## Checklist -_If relevant, ensure the following have been met:_ +_Ensure **all** of these are met:_ -- [ ] _Areas your change affects have been linted using rustfmt (`cargo fmt`)_ -- [ ] _The change has been tested and doesn't appear to cause any unintended breakage_ +- [ ] _If this is a code change, areas your change affects have been linted using (`cargo fmt`)_ +- [ ] _If this is a code change, new tests were added - I'm not worried about test coverage numbers but if it seems like a test is relevant please add it (especially for complex code!)_ +- [ ] _The change has been tested (see above) and doesn't appear to cause any unintended breakage_ - [ ] _Documentation has been added/updated if needed (`README.md`, help menu, doc pages, etc.)_ - [ ] _The pull request passes the provided CI pipeline_ - [ ] _There are no merge conflicts_ -- [ ] _If relevant, new tests were added (don't worry too much about coverage)_ +- [ ] _I have reviewed my own changes first_ + +## Other + +_Anything else that maintainers should know about this PR:_