From 9e0bed4c9ea0b4da14cead41217a9c052eb584cc Mon Sep 17 00:00:00 2001 From: Helena Zhang Date: Wed, 15 Mar 2023 14:02:31 -0400 Subject: [PATCH] Updated PR template (#1083) Because we've set the merge queue to use the PR description as the commit message to `main`, it's not good to start the PR template with a commented block that PR makers don't have to remove. The new template makes the checklist visible at the end and indicates it should be deleted. --- .github/PULL_REQUEST_TEMPLATE.md | 30 +++++++++++++++++++----------- 1 file changed, 19 insertions(+), 11 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 3851165634..1a76531ea9 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,18 +1,26 @@ - +Please describe what this PR changes as concisely as possible. Link to the issue(s) +that this addresses, if any. -### Summary +### Details and comments +Some details that should be in this section include: +- Why this change was necessary +- What alternative solutions were considered and why the current solution was chosen +- What tests and documentation have been added/updated +- What do users and developers need to know about this change -### Details and comments +Note that this entire PR description field will be used as the commit message upon +merge, so please keep it updated along with the PR. Secondary discussions, such as +intermediate testing and bug statuses that do not affect the final PR, should be in the +PR comments. +### PR checklist (delete when all criteria are met) +- [ ] I have read the contributing guide `CONTRIBUTING.md`. +- [ ] I have added the tests to cover my changes. +- [ ] I have updated the documentation accordingly. +- [ ] I have added a release note file using `reno` if this change needs to be + documented in the release notes.