Code Reviews: Why they're important and how to do them right

Dominic Baumgartner — Thu, 27 Apr 2023 07:56:57 +0000

As a developer, you might have come across code reviews during your work. And you might have wondered, why do we need code reviews? Isn't it enough to write code and test it? Well, the answer is no, and in this article, we will explore why code reviews are important, what to look for during a code review, and how to prepare for a merge request.

First of all, let's address the fact that there is no one-size-fits-all approach to code reviews. Every developer reviews a bit differently, and that's okay. The important thing is to have a review process in place and ensure that all the necessary aspects are covered.

So why do we need code reviews? There are several reasons, including learning and knowledge sharing, reviewing code quality, and functionality. Code reviews are an excellent opportunity to share knowledge and learn from each other. Additionally, code reviews help to ensure that the code is of high quality and meets the requirements. It's easier to find issues in someone else's code than in your own.

When reviewing code, there are several aspects to consider, including whether it makes sense, fits into the architecture, and is secure. It's also important to ensure that the solution is appropriate for the requirement and not overkill or "underkill." Code quality is another aspect to consider, including readability, stability, maintainability, performance, and security.

When it comes to merging code, it's essential to have a merge request or pull request (MR/PR) in place. This is where everything related to software changes comes together, including Git changes, discussions, and the CI/CD pipeline. Before opening an MR/PR, it's important to ensure that the code compiles and passes all tests. You should also review the code yourself and go over all the changes after making the last changes.

When creating an MR/PR, aim for one feature per request, and if possible, don't introduce too many changes. Smaller MRs are easier to review and ensure that all aspects are covered thoroughly.

In conclusion, code reviews are an important aspect of software development that should not be overlooked. They provide an opportunity for learning, ensure that the code is of high quality, and meets the requirements. By following a review process, considering various aspects of the code, and preparing for an MR/PR, developers can ensure that their code is of the highest quality.

Disclaimer
This post was written by a generative AI, based on a bulletpoint list I wrote down myself when I taught a Junior on the importance of Code Reviews and Merge Requests.

DEV Community: Dominic Baumgartner

Code Reviews: Why they're important and how to do them right