Skip to content
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add TBD PR template
  • Loading branch information
ShaharNaveh committed May 18, 2026
commit 1ab920661e2479d5fb6cb23835a2dcf3243af991
6 changes: 6 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<!--
Thanks for your contribution!

TBD

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not quite sure what to write here, any suggestions? @fanninpm @youknowone

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You could start with these sections:

  • What changed: Requesting a description of what the pull request changes in the human's own words. Here the contributor can disclose the use of AI assistance, if applicable. (Coderabbit will make its own summary)
  • Motivation: Requesting an explanation of why the pull request was made in the human's own words. (Language such as Closes #WXYZ should suffice, given some criteria [TODO: should be defined] that the linked issue has to meet.)
  • Verification: Requesting a summary of what steps were taken to verify the effectiveness of the PR's changes.
  • Checklist: Something like (with language to be refined):
    • If I changed something that impacts Rust code, I can confirm that I ran cargo whatever with no errors. (If not, please explain why.)
    • I can confirm that I ran (whatever other tool or tools (for the next few bullet points)) (If not, please explain why.)
    • If I have used AI assistance, I have disclosed it as such.
    • I understand that others, including the RustPython maintainers, will ask me questions about this pull request
    • I will respond to these questions in my own words to the best of my ability.
    • I understand that the RustPython maintainers will close my pull request if I do not check any of these boxes.

If you have anything to add to the checklist, it is a good idea to use the active voice in a manner similar to how I wrote the previous bullet points.


Separately from this PR, I think it would be a good idea to convert our Issue templates from Markdown into YAML format.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I liked that idea a lot. I've looked around in couple of FOSS projects and took what I liked. If you have a checkbox you would like to add/remove, please feel free to say (or even push it straight to my branch)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Separately from this PR, I think it would be a good idea to convert our Issue templates from Markdown into YAML format

I'll look into that:)


-->