-
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?
Conversation
| @@ -1,4 +1,4 @@ | |||
| [Issue Key](https://jira.mongodb.org/browse/{ISSUE_KEY}) | |||
| [JIRA TICKET](https://jira.mongodb.org/browse/{ISSUE_KEY}) | |||
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?
|
@Jibola make sure to add the blurb about the usage of AI |
caseyclements
left a comment
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.
Please review the checklists.
| @@ -1,4 +1,4 @@ | |||
| [Issue Key](https://jira.mongodb.org/browse/{ISSUE_KEY}) | |||
| [JIRA TICKET](https://jira.mongodb.org/browse/{ISSUE_KEY}) | |||
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?
| - [ ] 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?) |
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.
"Do you fully understand..." This line is for the Reviewer. Doubled here.
| - [ ] 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?) | ||
| - [ ] 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)? |
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.
The patch build line might be a line for the reviewer, too.
|
|
||
| ### Checklist for Author | ||
|
|
||
| - [ ] Did you update the changelog (if necessary)? |
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.
The changelog and relevant tests should still be there, no?
PYTHON-5401
Changes in this PR
Updated the pull request template to improve clarity and consistency in formatting.
Changed components of the PR template relative to this agreed upon doc
Test Plan
Test in prod
Checklist
Checklist for Author
Checklist for Reviewer