Skip to content

Commit 3f1390b

Browse files
authored
Simplify pull-request template (#15924)
The current template is quite wordy and hard to read. We have a properly rendered checklist in `CONTRIBUTING.md`, so it's clearest just to link to that; I'm not convinced that the existing comment actually drives user behaviour to do what we want, so I don't think we'll lose out by putting it a link away. I deleted the "summary" and "details and comments" section headings because they're usually below the fold of the text area anyway, and just busy-work to delete for PRs that come with a good commit message. One thing we definitely _do_ want in all PR descriptions, and is not possible for maintainers to manually do themselves, is to include a disclosure of the AI/LLM tooling used. This new template pre-populates that with tickboxes, including for the negative case, which should at least make it obvious to reviewers if all the information is present.
1 parent f8bd5d0 commit 3f1390b

1 file changed

Lines changed: 8 additions & 15 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,13 @@
11
<!--
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 a release note file using reno if the change needs to be documented in the release notes.
5-
⚠️ If your pull request fixes an open issue, please link to the issue. Use "Fixes #XXXX" if this PR *fully* closes the issue XXXX.
6-
☢️ If you used an AI tool to code this PR, add "AI tool used: <Name and version of the tool>". For example, "AI tool used: Microsoft Copilot Chat with GPT-5". Failing to disclose the use of AI tools may result in the PR being closed without further review.
7-
8-
9-
- [ ] I have added the tests to cover my changes.
10-
- [ ] I have updated the documentation accordingly.
11-
- [ ] I have read the CONTRIBUTING document.
2+
* See https://github.com/Qiskit/qiskit/blob/main/CONTRIBUTING.md#pull-request-checklist
3+
* Write a clear description here.
4+
* Use "Fix #15919" to close issues.
125
-->
136

14-
### Summary
15-
16-
17-
18-
### Details and comments
7+
### AI/LLM disclosure
198

9+
- [ ] I didn't use LLM tooling, or only used it privately.
10+
- [ ] I used the following tool to help write this PR description:
11+
- [ ] I used the following tool to generate or modify code:
2012

13+
<!-- Any code generated by LLM or modified from LLM suggestions must commented inline too. -->

0 commit comments

Comments
 (0)