Use this section to:
- Explain why the change is needed
- Explain what the PR does
- Clarify anything that might be unclear to a reviewer
- Highlight breaking changes if there are any
Mention and / or link to related issues or tasks, e.g. Jira
Optional: Mention anything you especially want reviewers to look at.
The following items should be checked before marking the PR as Ready for Review. For checklist items that do not apply, add a short note explaining why.
- I've written an informative title, finishing the sentence "This PR will..."
- I've explained what this PR does and why
- I've mentioned and linked related issues / tasks
- I've documented breaking changes, risks, assumptions, or open questions, if any
- The branch is up to date with
<default-branch> - The PR aligns with the Acceptance Criteria
- All configured checks pass
- Tests confirm the intended behaviour
- Unused code and debug leftovers have been removed
- Naming and structure follow the agreed style guidelines
- The changes made in the PR are documented appropriately
- I've performed a self-review of this PR
See the guidelines on how to review a PR. They offer useful tips that simplify the process for everyone involved.
Use the following checklist during the review.
Review broad to narrow:
- I understand the purpose of the PR
- The scope of the PR matches the Acceptance Criteria
- The behaviour matches the description
- Risks, assumptions, edge cases, and possible side effects have been considered
- Tests are present and meaningful, or the absence of tests is acceptable
- The code is clean, readable, maintainable, and follows agreed standards
Once the PR aligns with the Definition of Done and any discussions are resolved, approve the PR.