Skip to content

Commit 9e0bed4

Browse files
authored
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.
1 parent 16e7819 commit 9e0bed4

File tree

1 file changed

+19
-11
lines changed

1 file changed

+19
-11
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,26 @@
1-
<!--
2-
⚠️ If you do not respect this template, your pull request will be closed.
3-
⚠️ Your pull request title should be short detailed and understandable for all.
4-
⚠️ Also, please add it in the CHANGELOG file under Unreleased section.
5-
⚠️ If your pull request fixes an open issue, please link to the issue.
1+
### Summary
62

7-
✅ I have added the tests to cover my changes.
8-
✅ I have updated the documentation accordingly.
9-
✅ I have read the CONTRIBUTING document.
10-
-->
3+
Please describe what this PR changes as concisely as possible. Link to the issue(s)
4+
that this addresses, if any.
115

12-
### Summary
6+
### Details and comments
137

8+
Some details that should be in this section include:
149

10+
- Why this change was necessary
11+
- What alternative solutions were considered and why the current solution was chosen
12+
- What tests and documentation have been added/updated
13+
- What do users and developers need to know about this change
1514

16-
### Details and comments
15+
Note that this entire PR description field will be used as the commit message upon
16+
merge, so please keep it updated along with the PR. Secondary discussions, such as
17+
intermediate testing and bug statuses that do not affect the final PR, should be in the
18+
PR comments.
1719

20+
### PR checklist (delete when all criteria are met)
1821

22+
- [ ] I have read the contributing guide `CONTRIBUTING.md`.
23+
- [ ] I have added the tests to cover my changes.
24+
- [ ] I have updated the documentation accordingly.
25+
- [ ] I have added a release note file using `reno` if this change needs to be
26+
documented in the release notes.

0 commit comments

Comments
 (0)