PYTHON-5583: Add Pull Request template #8
Merged
Conversation
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
[PYTHON-5583](https://jira.mongodb.org/browse/PYTHON-5583) ## Summary <!-- What is this PR introducing? If context is already provided from the JIRA ticket, still place it in the Pull Request as you should not make the reviewer do digging for a basic summary. --> Adds a Pull Request template to this repository based on our new dbx-python code review policy. ## Changes in this PR <!-- What changes did you make to the code? What new APIs (public or private) were added, removed, or edited to generate the desired outcome explained in the above summary? --> * PULL_REQUEST_TEMPLATE.md ## Test Plan <!-- How did you test the code? If you added unit tests, you can say that. If you didn’t introduce unit tests, explain why. All code should be tested in some way – so please list what your validation strategy was. --> Make a PR from this branch to confirm ### Screenshots (optional) <!-- Usually a great supplement to a test plan, especially if this requires local testing. --> ## Checklist <!-- Do not delete the items provided on this checklist --> ### Checklist for Author - [x] Did you update the changelog (if necessary)? **Not necessary** - [x] Is the intention of the code captured in relevant tests? **Not necessary** - [x] If there are new TODOs, has a related JIRA ticket been created? **Not necessary** ### Checklist for Reviewer [@NoahStapp] - [ ] Does the title of the PR reference a JIRA Ticket? - [ ] Do you fully understand the implementation? (Would you be comfortable explaining how this code works to someone else?) - [ ] Have you checked for spelling & grammar errors? - [ ] Is all relevant documentation (README or docstring) updated? ## Focus Areas for Reviewer <!-- List any complex portion of code you believe needs additional scrutiny and explain why. --> For reviewers provide suggestions on what should be changed about the checklist to better cater to this repository.
NoahStapp
requested changes
Sep 25, 2025
| <!-- How did you test the code? If you added unit tests, you can say that. If you didn’t introduce unit tests, explain why. All code should be tested in some way – so please list what your validation strategy was. --> | ||
|
|
||
|
|
||
| ### Screenshots (optional) |
There was a problem hiding this comment.
What is a "screenshot" in this case? An example of the code working? A literal photo of the result?
There was a problem hiding this comment.
It can be anything to substantiate proof of correctness. I generally show a "before" and "after" code snippet of the output. In other cases, I've shown a literal photo. Either way, it's a means of showing a visible, expected result.
There was a problem hiding this comment.
Makes total sense. The word "Screenshot" doesn't convey that effectively to me, something like "proof of result" is clearer.
There was a problem hiding this comment.
To keep consistent across the other template additions, I'll go ahead and provide more details in the comments.
Jibola
commented
Sep 29, 2025
NoahStapp
requested changes
Oct 3, 2025
| <!-- How did you test the code? If you added unit tests, you can say that. If you didn’t introduce unit tests, explain why. All code should be tested in some way – so please list what your validation strategy was. --> | ||
|
|
||
|
|
||
| ### Screenshots (optional) |
There was a problem hiding this comment.
Makes total sense. The word "Screenshot" doesn't convey that effectively to me, something like "proof of result" is clearer.
Jibola
commented
Oct 22, 2025
NoahStapp
approved these changes
Oct 22, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
PYTHON-5583
Summary
Adds a Pull Request template to this repository based on our new dbx-python code review policy.
Changes in this PR
Test Plan
Make a PR from this branch to confirm
Screenshots (optional)
Checklist
Checklist for Author
Checklist for Reviewer [@NoahStapp]
Focus Areas for Reviewer
For reviewers provide suggestions on what should be changed about the checklist to better cater to this repository.