-
Notifications
You must be signed in to change notification settings - Fork 38
PYTHON-5401: Revise PR template for improved clarity and checks #279
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?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| [Issue Key](https://jira.mongodb.org/browse/{ISSUE_KEY}) | ||
| [JIRA TICKET](https://jira.mongodb.org/browse/{ISSUE_KEY}) | ||
|
|
||
| ## Summary | ||
|
|
||
|
|
@@ -12,28 +12,19 @@ | |
|
|
||
| <!-- 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)? | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The changelog and relevant tests should still be there, no? |
||
| - [ ] Is the intention of the code captured in relevant tests? | ||
| - [ ] If there are new TODOs, has a related JIRA ticket been created? | ||
| - [ ] 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?) | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "Do you fully understand..." This line is for the Reviewer. Doubled here. |
||
| - [ ] Is all relevant documentation (README or docstring) updated? | ||
| - [ ] Has a MongoDB Employee run [the patch build of this PR](https://github.com/mongodb-labs/ai-ml-pipeline-testing?tab=readme-ov-file#running-a-patch-build-of-a-given-pr)? | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The patch build line might be a line for the reviewer, too. |
||
|
|
||
| ### 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 particular scrutiny and explain why. --> | ||
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 thought we were going to let the autolink work for this?
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.
Autolink from the title?