-
Notifications
You must be signed in to change notification settings - Fork 81
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
Adds PR review checklist #1007
Adds PR review checklist #1007
Conversation
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.
One quick add: if the PR includes a migration, make sure the migration label has been applied
@amplifi Added comment about migrations |
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.
Nit picky, take it or leave it. This looks good.
#### General | ||
|
||
- [ ] **Is the PR labeled correctly?** It should have the `migration` label if a new migration is added. | ||
|
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.
Is this PR explained thoroughly? Are all the code changes accounted for in the description of the PR?
Maybe something about risk level? If it's a high risk, has this been taken into consideration?
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.
Good comments, I added those points
#### Tests | ||
|
||
- [ ] **Are there sufficient test cases?** Ensure that all components are tested individually; models, forms, and serializers should be tested in isolation even if a test for a view covers these components. If this is a bug fix, there must be a test case for the bug to ensure the issue won’t regress. | ||
|
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 would split bug fix into a separate check, and ask if the new tests break without the new code to fix it.
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.
Added this.
Proposed changes in this pull request
This PR adds a review checklist to the pull request template. The checklist lists things to look out for. It might not be exhaustive, feel free to add anything that is missing.
When should this PR be merged
Anytime
Risks
None
Follow up actions
None