Skip to content

PYTHON-5583: Add Pull Request template #8

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.

Sign up for GitHub

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

PYTHON-5583: Add Pull Request template #8

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4475f29
PYTHON-5583: Add Pull Request template
Jibola Sep 25, 2025
b8c68cf
Reformatted PR template
Jibola Sep 29, 2025
9852d33
Lint fixes
Jibola Sep 29, 2025
f296a52
Update .github/PULL_REQUEST_TEMPLATE.md
Jibola Sep 29, 2025
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
38 changes: 38 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
[Issue Key](https://jira.mongodb.org/browse/%7BISSUE_KEY%7D)

## 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. -->

## 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? -->

## 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. -->

### Screenshots (optional)
Copy link
Collaborator

Choose a reason for hiding this comment

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

What is a "screenshot" in this case? An example of the code working? A literal photo of the result?

Copy link
Author

Choose a reason for hiding this comment

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

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.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Makes total sense. The word "Screenshot" doesn't convey that effectively to me, something like "proof of result" is clearer.


<!-- 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

- [ ] Did you update the changelog (if necessary)?
- [ ] Is the intention of the code captured in relevant tests?
- [ ] If there are new TODOs, has a related JIRA ticket been created?

### Checklist for Reviewer {@primary_reviewer}

- [ ] 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. -->