- Describe the objective or issue this PR addresses, as well as the impact of the change.
- Try to keep the description accessible to newcomers.
- If you're resolving a specific issue, add "Fixes #issue_number" or "Closes #issue_number".
- Describe the approach taken to achieve the objective / resolve the issue.
- If this PR contains a breaking change relative to the
mainbranch, provide an instruction on how affected parties might need to adapt to the change.
- For complex PRs, try to provide some information on how to approach the review more effectively.
- For example, is there a natural order in which the affected files should be reviewed?
- I've read
CONTRIBUTING.md. - (optional) I've written unit tests for the code changes.
- All review comments have been resolved.
- All CI checks pass.