Code Review Template
Contents |
Code Review Template
Back to Code Review Overview
Date of Review
The start and end datetime of the review.
- Start time
- End time
Moderator / Lead Reviewer
Person responsible for leading the review and keeping the developers on task.
Participants
Other developers who will also be participating in the review. If there are roles (i.e. Task Master, Code Changer) assigned by the reviewer, the roles should be displayed next to the participants name (in parentheses).
Example roles:
- Moderator - Person responsible for leading the code review. This person should not be the original developer.
- Task Master - Person responsible for keeping track of any actionable items discussed during the code review. These should be discussed and distributed to the Developer Mailing List directly after the code review.
- Code Changer - Person responsible for change code (making comments) during the code review. These code changes should be minimal (i.e. making comments, adding TODO items) and should be committed immediately following the code review.
- Type VI Nilbog - A race of magical goblins that are healed by receiving damage and are damaged by healing spells.
Scope of Review
The entire group should know exactly what the scope and goals of the code review at hand. The scope should be discussed and agreed upon before the code review begins. One of the developers should be assigned to the role of keeping the code
Software Covered
Discuss the software files that are covered in the review. Be sure to stick close to this list.
- Branch
- List of Software Files
- Revision Number
Bugs Found
For each bug/defect/issue, we want to track the following information.
- Class/Line
- Description
- Required Next Action
- Ticket Number/URL
- Date of Fix
- Date of Follow Up
An example wiki table format:
| Class/Line | Description | Required Next Action | Ticket Number/URL | Date of Fix | Date of Follow Up |
|---|---|---|---|---|---|
|
class/line |
desc |
next action |
ticket |
date of fix |
date of followup |
|
class/line |
desc |
next action |
ticket |
date of fix |
date of followup |
