Code Review Checklist
From OpenLaszlo
The goal of the review checklist is to make sure that changes preserve these invariants: the code is defect-free (no new logic and maintenance errors); the code matches the design; and the code matches the requirements (no unnecessary features, or features that don't meet the requirements). This checklist is a means to that end.
Contents |
[edit]
The Big Four
- Do you understand the code?
- Are there test cases for code changes?
- Does the changeset description include the required fields of the Change Description Template?
- Do all changes implement a required feature, or fix a bug that is listed in the change description?
[edit]
Coding Standards
- Does the code adhere to the Code Guidelines?
- Are constant parameters literally inserted into the code?
- Does a method definition comment document which of its parameters the method is going to change?
[edit]
Design
- Do you understand the design?
- Does the implementation match the design?
- Are all functions in the design coded?
[edit]
Maintainability
- Are the comments necessary?
- Are the comments accurate?
- Are variable names spelled correctly and consistently?
- Are variables documented with (where it's not obvious): units of measure, bounds, and legal values?
- Do you understand the code?
- Are there test cases for code changes?
[edit]
Documentation
- Are command-line arguments and environment variables documented?
- Is user-visible functionality described in the user documentation?
- Does the implementation match the documentation?
- Are the changes described in the changeset description?
- Does the changeset description include the required fields of the Change Description Template?
[edit]
Requirements Tracing
- Do all changes implement a required feature, or fix a bug that is listed in the change description?
