diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index e6d94a61..f8ab545c 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,34 +1,55 @@ ## Motivation - +_What are the most important goals of the ticket or PR?_ + + +### PR Author Checklist + +#### Check before marking the PR as ready for review: + - [ ] Will the PR name make sense to users? + - [ ] Does the PR have a priority label? + - [ ] Have you added or updated tests? + - [ ] Is the documentation up to date? + +##### For significant changes: + - [ ] Is there a summary in the CHANGELOG? + - [ ] Can these changes be split into multiple PRs? + +_If a checkbox isn't relevant to the PR, mark it as done._ ### Specifications + ### Complex Code or Requirements + ## Solution + +### Testing + + + + ## Review + ### Reviewer Checklist - - [ ] Will the PR name make sense to users? - - [ ] Does it need extra CHANGELOG info? (new features, breaking changes, large changes) - - [ ] Are the PR labels correct? - - [ ] Does the code do what the ticket and PR says? - - [ ] Does it change concurrent code, unsafe code, or consensus rules? - - [ ] How do you know it works? Does it have tests? +Check before approving the PR: + - [ ] Does the PR scope match the ticket? + - [ ] Are there enough tests to make sure it works? Do the tests cover the PR motivation? + - [ ] Are all the PR blockers dealt with? + PR blockers can be dealt with in new tickets or PRs. + +_And check the PR Author checklist is complete._ ## Follow Up Work