Achieving Drama-Free Code Reviews | by Adi Sahai | Jan, 2024 | Medium

Introduction

Code reviews are an essential part of the software development process. They provide an opportunity for developers to collaborate, learn from each other, and ensure the quality of the code. However, code reviews can sometimes become contentious and lead to unnecessary drama. In this blog post, I will share my tips for achieving drama-free code reviews. By following these guidelines, you can create a positive and productive environment for code reviews.

Approaching Code Reviews with an Open Mind

When reviewing code, it’s important to approach it with an open mind and a growth mindset. Rather than immediately criticizing or finding faults, try to understand the author’s perspective and provide feedback in a constructive manner. Instead of pointing out mistakes directly, ask questions to encourage a dialogue and deeper understanding. This approach fosters better communication and collaboration, leading to more effective code reviews.

Reading the Description and Skimming Through the Changes

Before diving into the code, take the time to read the pull request description. This might seem obvious, but it’s easy to overlook when you’re busy. The description often provides important context and answers many questions you may have. After reading the description, skim through the changes. Start by reviewing the unit tests, as they give you an idea of how the code is intended to work. If anything jumps out at you, address it first. Otherwise, if the changes are straightforward, you can often approve the pull request without much further discussion.

Testing Complex Changes and Focusing on Best Practices

For more complex changes, it’s beneficial to pull down the code and review it in your IDE. This allows you to manually test the changes and ensure they work as intended. Set breakpoints and step through the code to understand its functionality. Pay attention to code organization, naming conventions, and adherence to best practices. If you come across code that you appreciate or find clever, don’t hesitate to acknowledge it. Positive reinforcement encourages good coding practices and boosts team morale.

If unsure, add suggestions

If you are not about a change but don’t want to hold back the pull request from being merged, add suggestions, but don’t request changes, which blocks the pull request. If another reviewer approves it then code can still be merged, but your point of view or suggestions will be acknowledged. At this point it is up to the author to follow the suggestion or not.

Conclusion

Code reviews are a valuable part of the software development process, but they don’t have to be dramatic or contentious. By approaching code reviews with an open mind, asking questions instead of criticizing, and focusing on best practices, you can create a positive and productive environment for collaboration. Remember to leave your ego at the door and strive for constructive feedback. With these tips, you can achieve drama-free code reviews and foster a stronger and more efficient development team.

Be curious always, ask questions!