Code Review

Code review systematically examines and evaluates source code to identify defects, improve quality, and ensure adherence to coding standards and best practices. It involves having one or more developers review the code written by their peers or team members

The primary goals of code review are:

Related Tools

Access Checklists Templates Streamlining Change Approval Onboarding a New Team Member

Code review helps catch bugs, logic errors, and other defects early in the development process
By having fresh eyes examine the code, issues that may have been overlooked during development can be identified and addressed before they impact the software's functionality

Code review promotes code quality by enforcing coding standards, best practices, and design principles
Reviewers can provide feedback on code structure, modularity, readability, maintainability, and performance, leading to cleaner, more efficient, and easier-to-maintain code

Code review provides an opportunity for team members to learn from each other
Reviewers can share insights, suggest alternative approaches, and offer constructive feedback, fostering knowledge transfer and professional growth within the team

Code review ensures consistency across the codebase by enforcing coding guidelines and architectural patterns
It encourages collaboration and a shared understanding of the code among team members, reducing knowledge silos and promoting collective code ownership

The code review process typically involves the following steps:

Preparing for Review: The author of the code submits the code changes for review, along with any relevant documentation or context.
Reviewer Selection: One or more developers are assigned as reviewers based on their expertise and availability.
Review Process: The reviewers thoroughly examine the code, looking for defects, potential improvements, and adherence to coding standards. They may use manual code inspection techniques or utilize automated code review tools for assistance.
Feedback and Discussions: Reviewers provide feedback, comments, suggestions, and questions on the code. Discussions may take place to clarify any doubts or address specific issues.
Iteration and Revision: The code author incorporates the feedback and makes necessary revisions to the code. This iterative process continues until the code is deemed satisfactory by the reviewers.
Approval and Merge: Once the code review process is complete and all issues have been addressed, the code changes are approved, and the changes are merged into the main codebase.

Adoption Expectations:

System Components	MVP	MVP+
Define code review checklist	+	+
Add code review practice	+	+

Tools:

Functionality	Tool Name
Test automation and in-sprint automation	Git
Version Control Collaboration	Azure DevOps Repo, Bitbucket
Build automation tools	Jenkins, Bamboo, TeamCity, Azure DevOps
Containerization and orchestration tools	Docker, Kubernetes, OpenShift
Test Automation	JUnit, NUnit, Rest Assured, Selenium

Name	Responsibilities
Scrum Master/Team Coach	Coach and support usage of code review process and pair programming
Developer	Review code quality via defined code review checklist
Build Engineer	Integrate automated quality gates to promote code changes

Effective code review requires a constructive and collaborative mindset, clear communication, and respect for the code author. It is important to focus on the code and its quality rather than criticizing individuals. A balance between providing actionable feedback and recognizing good practices is key to fostering a positive and productive code review culture.

By incorporating code review as a regular practice within the development workflow, teams can enhance code quality, reduce defects, promote knowledge sharing, and create a more cohesive and efficient development process