The primary motivation behind any code review is to improve the overall quality of the code. Code quality is very important. This almost goes without saying, especially if your code is part of a team project or is accessible to others, such as open source developers and customers through escrow agreements.
If every developer was free to code as they pleased, you would end up with the same kind of code written in so many different ways, and ultimately the code would become an unwieldy mess. That is why it is important to have a coding standards policy that outlines the company's coding practices and code review procedures that are to be followed.
When code reviews are carried out, colleagues will review the code of other colleagues. Colleagues will understand that it is only human to make mistakes. They will check the code for mistakes, coding that breaks the company's code of coding conduct, and any code that, while syntactically correct, can be improved upon to either make it more readable, more maintainable, or more performant.
Therefore, in this chapter, we will cover the following topics to understand the code review process in detail:
- Preparing code for review
- Leading a code review
- Knowing what to review
- Knowing when to send code for review
- Providing and responding to review feedback
The learning objectives for this chapter are for you to be able to do the following:
- Understand code reviews and why they are good
- Partake in code reviews
- Provide constructive criticism
- Respond positively to constructive criticism
Before we dive deep into these topics, let's understand the general code review process.
