Skip to content

Commit 4475f29

Browse files
authored
PYTHON-5583: Add Pull Request template
[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.
1 parent dddd51f commit 4475f29

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
[Issue Key](https://jira.mongodb.org/browse/{ISSUE_KEY})
2+
3+
4+
## Summary
5+
<!-- 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. -->
6+
## Changes in this PR
7+
8+
9+
<!-- 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? -->
10+
11+
12+
## Test Plan
13+
14+
15+
<!-- 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. -->
16+
17+
18+
### Screenshots (optional)
19+
20+
21+
<!-- Usually a great supplement to a test plan, especially if this requires local testing. -->
22+
23+
24+
## Checklist
25+
26+
27+
<!-- Do not delete the items provided on this checklist -->
28+
29+
30+
### Checklist for Author
31+
32+
33+
- [ ] Did you update the changelog (if necessary)?
34+
- [ ] Is the intention of the code captured in relevant tests?
35+
- [ ] If there are new TODOs, has a related JIRA ticket been created?
36+
37+
38+
### Checklist for Reviewer {@primary\_reviewer}
39+
40+
41+
- [ ] Does the title of the PR reference a JIRA Ticket?
42+
- [ ] Do you fully understand the implementation? (Would you be comfortable explaining how this code works to someone else?)
43+
- [ ] Have you checked for spelling & grammar errors?
44+
- [ ] Is all relevant documentation (README or docstring) updated?
45+
46+
47+
## Focus Areas for Reviewer
48+
49+
50+
<!-- List any complex portion of code you believe needs additional scrutiny and explain why. -->

0 commit comments

Comments
 (0)