Skip to content

Commit 97b0f0c

Browse files
authored
PYTHON-5401: Revise pull request template for better structure
Updated the pull request template to improve clarity and consistency in formatting.
1 parent 222a55f commit 97b0f0c

File tree

1 file changed

+7
-16
lines changed

1 file changed

+7
-16
lines changed

.github/pull_request_template.md

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,29 @@
11
<!-- Thanks for contributing! -->
22
<!-- Please ensure that the title of the PR is in the following form:
3-
[Issue Type]-[Issue Key]: Issue Title
3+
[JIRA TICKET]: Issue Title
44
55
If you are an external contributor and there is no JIRA ticket associated with your change, then use your best judgement
66
for the PR title. A MongoDB employee will create a JIRA ticket and edit the name and links as appropriate.
77
-->
8-
[Issue Key](https://jira.mongodb.org/browse/%7BISSUE_KEY%7D)
9-
## Summary
10-
<!-- What conceptually is this PR introducing? If context is already provided from the JIRA ticket, still place it in the
11-
Pull Request as you should not make the reviewer do digging for a basic summary. -->
8+
[JIRA TICKET](https://jira.mongodb.org/browse/%7BJIRA_TICKET%7D)
129

1310
## Changes in this PR
1411
<!-- What changes did you make to the code? What new APIs (public or private) were added, removed, or edited to generate
1512
the desired outcome explained in the above summary? -->
1613

17-
## Testing Plan
14+
## Test Plan
1815
<!-- How did you test the code? If you added unit tests, you can say that. If you didn’t introduce unit tests, explain why.
1916
All code should be tested in some way – so please list what your validation strategy was. -->
2017

21-
### Screenshots (optional)
22-
<!-- Usually a great supplement to a test plan, especially if this requires local testing. -->
23-
2418
## Checklist
2519
<!-- Do not delete the items provided on this checklist. -->
20+
2621
### Checklist for Author
2722
- [ ] Did you update the changelog (if necessary)?
28-
- [ ] Is the intention of the code captured in relevant tests?
29-
- [ ] If there are new TODOs, has a related JIRA ticket been created?
23+
- [ ] Is there test coverage?
24+
- [ ] Is any followup work tracked in a JIRA ticket? If so, add link(s).
3025

31-
### Checklist for Reviewer {@primary_reviewer}
26+
### Checklist for Reviewer
3227
- [ ] Does the title of the PR reference a JIRA Ticket?
3328
- [ ] Do you fully understand the implementation? (Would you be comfortable explaining how this code works to someone else?)
34-
- [ ] Have you checked for spelling & grammar errors?
3529
- [ ] Is all relevant documentation (README or docstring) updated?
36-
37-
## Focus Areas for Reviewer (optional)
38-
<!-- List any complex portion of code you believe needs additional scrutiny and explain why. -->

0 commit comments

Comments
 (0)