Code Review
What is Code Review?
Code Review is the process throughout which source code gets assessed by one or more software developers or engineers. A thorough reviewer usually looks for inconsistencies, errors, potential bugs, problems in design and architecture, and issues of performance and security. Its benefits include an increase of collaboration, mitigation of risks, and a decrease of knowledge silos.
Definitions:
Author: Developer that produced the source code
Reviewer: Developer assigned to review source code
Tech Lead: Technical manager of author
Review Master: Developer in charge of code review activities
Code Review Best Practices
Code Review Checklist
Authors:
Unit tests must accompany all new and modified code
Unit tests must be modified to reflect modified or removed code
NO code should be merged to “Develop” without a sign-off from Reviewer and explicit approval from Tech Lead and Review Master
Any test data used for developer testing should be deposited and annotated in the Test_Data repository before sending code for review
This document should NOT be modified without the explicit approval of the Product Manager