Audio version of this article

Audio version of this article

Why review each other’s code?

As a Team Lead, advocating for team-wide code reviews has consistently brought significant benefits.

On a technical level, it helps to enhance code comprehension, detecting errors early and improving overall code quality. Furthermore, well-executed code reviews serve as efficient tools for feedback loop and conflict prevention within Engineering teams.

So, to put it another way, peer code review strengthens both the technical and human aspect by fostering an environment where trust and collaboration are central.

If you are the author of the MR

Picture this, you have been working on a new feature for quite some time, and now is the time to have your work reviewed. How do you do this?

Let’s state the golden rule of any code review: ✨ Always value your reviewer’s time ✨.

This is by far the most effective principle, and the tips below can all be traced back to it.

Tip 1: Make sure your MR has a manageable scope

Creating a Merge Request focused on a single task offers many advantages.

First, it simplifies the comprehension of the code's function. If the scope of your MR creeps, it will inevitably take a considerable amount of time to review every nuance.

Second, as a natural result of the first point, a big MR with dozens of files changes can lead to oversights. It's crucial to ensure that MR reviews lead to enhancements and are not merely overlooked.

Tip 2: Self-review