-
Notifications
You must be signed in to change notification settings - Fork 4
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.
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
base: main
Are you sure you want to change the base?
Conversation
[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.
<!-- 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.
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?
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.
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.
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.