-
Notifications
You must be signed in to change notification settings - Fork 2.9k
Simplify pull-request template #15924
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,13 @@ | ||
| <!-- | ||
| ⚠️ If you do not respect this template, your pull request will be closed. | ||
| ⚠️ Your pull request title should be short detailed and understandable for all. | ||
| ⚠️ Also, please add a release note file using reno if the change needs to be documented in the release notes. | ||
| ⚠️ If your pull request fixes an open issue, please link to the issue. Use "Fixes #XXXX" if this PR *fully* closes the issue XXXX. | ||
| ☢️ 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. | ||
| - [ ] I have added the tests to cover my changes. | ||
| - [ ] I have updated the documentation accordingly. | ||
| - [ ] I have read the CONTRIBUTING document. | ||
| * See https://github.com/Qiskit/qiskit/blob/main/CONTRIBUTING.md#pull-request-checklist | ||
| * Write a clear description here. | ||
| * Use "Fix #15919" to close issues. | ||
| --> | ||
|
|
||
| ### Summary | ||
|
|
||
|
|
||
|
|
||
| ### Details and comments | ||
| ### AI/LLM disclosure | ||
|
|
||
| - [ ] I didn't use LLM tooling, or only used it privately. | ||
| - [ ] I used the following tool to help write this PR description: | ||
| - [ ] I used the following tool to generate or modify code: | ||
|
|
||
| <!-- Any code generated by LLM or modified from LLM suggestions must commented inline too. --> | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we really get rid of this part? I mean. I know some contributions don't require us to write tests, or update docs, but it is a good reminder to have.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would suggest to keep them and also mention release notes:
I have updated the documentation and release notes accordingly.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
and perhaps also add another item on format checking?
(it seems that most comments that I write deal with failing tests / missing release notes / format errors...) - maybe we should use LLMs to automate this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The question is how detailed we want to be here: the checklist for a PR is already in the linked contributing guide, so we don't have to duplicate it here. I think I'd be in favor of trying a minimal template and explicitly point out the guide. If we realize it doesn't work and PR description drops, we can still change it
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree, but I'm afraid that human users don't actually read the guidelines (and I'm not sure about LLMs ;)
Perhaps we can use some automated Bot that will comment on missing CLA / tests / release notes / formatting issues...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not every PR needs tests or release notes -- and we do have a CLA bot and formatting issues are caught by CI 🙂
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shall we try this for now? I'm happy to do this and then change again if we don't like it.