From 3ee950003b426a5a029f9da2cd52b7689004624c Mon Sep 17 00:00:00 2001 From: Clement Tsang <34804052+ClementTsang@users.noreply.github.com> Date: Mon, 17 Nov 2025 06:14:06 -0500 Subject: [PATCH] other: update the PR template (#1879) --- .github/pull_request_template.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 4dd60977..55872782 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -2,9 +2,7 @@ ## 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 or recordings** of the changes:_ +_A description of the change, what it does, and why it was made. If relevant (e.g. UI changes), **please also provide screenshots/recordings**:_ ## Issue @@ -14,25 +12,28 @@ Closes: # ## Testing -_If relevant, please state how this was tested (including steps if necessary):_ +_If relevant, please state how this was tested (including steps):_ _If this change affects the program, please also indicate which platforms were tested:_ - [ ] _Windows_ -- [ ] _macOS_ +- [ ] _macOS (specify version below)_ - [ ] _Linux (specify distro below)_ +- [ ] _Other (specify below)_ ## Checklist _Ensure **all** of these are met:_ - [ ] _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_ +- [ ] _If this is a code change, your changes pass `cargo clippy --all -- -D warnings`_ +- [ ] _If this is a code change, new tests were added if relevant_ +- [ ] _If this is a code change, your changes pass `cargo test`_ +- [ ] _The change has been tested to work (see above) and doesn't appear to break other things_ +- [ ] _Documentation has been updated if needed (`README.md`, help menu, docs, configs, etc.)_ - [ ] _There are no merge conflicts_ -- [ ] _I have reviewed my own changes first_ +- [ ] _You have reviewed the changes first_ +- [ ] _The pull request passes the provided CI pipeline_ ## Other