RI+Dev+Process+Appendix+B+-+Code+Review+Checklist

=Appendix B – Code Review Checklist=

Code Review Checklist
The following items must be evaluated in order to conduct a Code Review. All items must be approved before the proposed code is approved.

Conforms to approved design
The proposed code must be a faithful implementation of the associated design previously approved.

Satisfies requirement and/or resolves issue
The proposed code must satisfy all of the requirements or resolve all of the issues addressed by the design.

Conforms to coding standards and practices
The proposed code must conform to the coding standards and best practices currently in effect.

Adequate unit test coverage
The unit tests accompanying the proposed code must provide adequate coverage of the code’s functionality. The meaning of “adequate” in this context is subject to the agreement of the work group participants. It is suggested that the tests cover all happy paths, major exception paths, and all boundary conditions. It is also suggested that automatically generated code not be covered by unit tests; only hand-made code needs to be tested.

Unit tests all green
All unit tests must complete successfully.

No code style errors
Using CheckStyle or a similar tool driven by the current standard configuration file must yield no errors.

No compile errors
There must be no compilation errors.

No build errors
There must be no build errors.

Passes smoke test
After synchronizing with the shared codebase, building the system, and deployment, the system must pass the standard smoke test with the proposed code in place.

Conformance to process
At this point in the process, the following criteria must be met.
 * The changeset must be associated with at least one planned task in the issue-tracking system.
 * The status value of the task must show that it is in progress.
 * The changeset to be reviewed must be associated with the task in the issue-tracking system.

Return to S&I Framework RI Development Process