Code review (author and reviewer) checklist template
For authors and reviewers on every pull request, in Author, Reviewer and Merge sections. The author self reviews for debug code and secrets, the reviewer checks logic, tests and the diff for personal data, and CI must be green.
- App: Checklist Flow for Jira
- Category: Code review
- Edition: Installs with or without a paid licence
- Items: 12 items, 8 required
- Suggested for: Story, Task, Bug, Sub-task
Items
#Author
| Item | Required |
|---|---|
| Pull request description explains what changed and why | Required |
| Work item key is in the branch name or pull request title | Required |
| Self review done: no debug code, commented out code or secrets | Required |
| Screenshots or a recording attached for user interface changes | Optional |
Reviewer
| Item | Required |
|---|---|
| Logic is correct and edge cases are handled | Required |
| Tests cover the change and are meaningful | Required |
| No secrets, credentials or personal data in the diff | Required |
| Names, structure and comments are clear | Optional |
| Performance impact considered for hot paths and queries | Optional |
Merge
| Item | Required |
|---|---|
| All review comments resolved | Required |
| CI is green | Required |
| Branch deleted after merge | Optional |
Use it
#In a Jira work item, open the Checklist Flow panel, then Template library in the Templates section. Find the template under its category, use Preview to see the items and Install to add it to your site's templates. From then on you can apply it to any work item, or, with a paid licence, have it added automatically by issue type.
Related
#- Checklist Flow for Jira documentation
- Jira checklist templates: all 49 templates