PYTHON-5576: add PR template to mongo-python-driver #2567
+41
−24
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 |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| <!-- Thanks for contributing! --> | ||
| <!-- Please ensure that the title of the PR is in the following form: | ||
| [Issue Type]-[Issue Key]: Issue Title | ||
|
|
||
| If you are an external contributor and there is no JIRA ticket associated with your change, then use your best judgement | ||
| for the PR title. A MongoDB employee will create a JIRA ticket and edit the name and links as appropriate. | ||
| --> | ||
| [Issue Key](https://jira.mongodb.org/browse/%7BISSUE_KEY%7D) | ||
| ## Summary | ||
| <!-- What conceptually is this PR introducing? If context is already provided from the JIRA ticket, still place it in the | ||
|
There was a problem hiding this comment. Is a JIRA ticket required? I think so. This should be included, as should our convention for naming PRs, as well as including a link to our jira project. There was a problem hiding this comment. Added jira link to the top. There was a problem hiding this comment. @sleepyStick Here's some more content that you can use to update this based on our team meeting. There was a problem hiding this comment. Sorry if I'm misunderstanding your most recent comment. But I've gone ahead and added a blurb in the template about PR name. |
||
| 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? --> | ||
|
|
||
| ## Testing 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) | ||
| <!-- 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 (optional) | ||
| <!-- List any complex portion of code you believe needs additional scrutiny and explain why. --> | ||
|
|
||
| <!-- See also: https://docs.google.com/document/d/1Z-z6BDIBJ9G4fn4MBb7Ql5A1NiSY6nsLfEE3KuU_Btw/edit?tab=t.exaie3tsb7gl#heading=h.asd8fqlsyzb6 --> | ||
Oops, something went wrong.
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.
I'm confused by this line. We don't include a hyperlink...
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 felt that it could be useful to include a link to the jira ticket in the PR body directly. Sometimes tickets have extra context in the comments and this would make it easier for reviews to get to the jira ticket (esp since putting the ticket in the title isn't a hyper link to jira itself)