What to do When You're Tired of Slow Code Reviews

Written by dawchihliou | Published 2022/12/06
Tech Story Tags: programming | software-engineering | code-review | technology | productivity | code-quality | learning-to-code | code-reviews

TLDRšŸŽ Learn how to accelerate the code review process to maximize your productivity šŸ”¬ Learn the best practices I came across for code reviewers āœļø Learn the best practices I came across for pull request authorsvia the TL;DR App

TL;DR

  • šŸŽ Learn how to accelerate the code review process to maximize your productivity
  • šŸ”¬ Learn the best practices I came across for code reviewers
  • āœļø Learn the best practices I came across for pull request authors

Imagine this.

You just implemented a feature and wrote all the test cases. You felt great about the code so you opened a pull request and let your coworkers know. After days passing by, your pull request looked exactly the same as before. Seemingly untouched. No comment. No change request. You asked your coworkers again for code review and they agreed. Another week went by and nothing happened. You asked again and they told you that they needed more time because it wasn't a small PR and there was a lot to take into consideration.

Finally, you saw a notification about a change request and you jumped on it right away. After resolving merge conflicts and fixing the edge cases, you requested a review again, and waited. Another change request appeared after a few days and you repeated the process again. You got an approval after another revision and the PR was finally merged to the trunk.

After 4 weeks since you opened the PR.

If you can relate to it, you're not alone. Many teams experienced such a slow code review process. In fact, it's one of the major blockers in the development cycle. So I want to share with you the best practices of code review I learned to speed up the development and help you ship code faster.

Let's go.

For Pull Request Authors

The number one thing I've learned to boost code review productivity is to be thoughtful as an author. Other than producing clean code, there are many small things you can do to help your reviewers understand your pull requests proactively.

Be The Driver

You, the author, are the driver of the pace. Knowing that you rely on your coworkers during the code review process, you can clearly communicate the when and what upfront to align expectations.

The when is the most important to communicate because it tells your reviewers how urgent it is. The reviewers can plan their work accordingly. It's a great way to set a timebox for the review process, and it's also a great way to show respect to your coworkers' time.

To communicate the what, make sure you include a PR description that focuses on helping your reviewers understand the purpose and code design of your changes. Instead of listing functionalities, start with an opening paragraph explaining the background and why this PR is needed helps the reviewers to build their mental models. Other descriptions I find very useful are:

Keep It Concise

Small, laser-focused pull requests are the easiest to read. How small? Google Engineering Practices say "can't make it small enough". A study has shown that the code review quality decreases as the code change increases. The longer your reviewers review at a time, the less defects they catch. So it's important to keep your pull request small and focus on one thing. If the feature you're developing is too large, you can consider splitting it into multiple pull requests using the "stacked pull request" technique.

It replaces a large pull request with a sequence of small pull requests. It helps the reviewers to focus on one thing at the time and aligns brilliantly with the principal of continuous integration and continuous delivery.

For Code Reviewers

Be Mindful about Biases

A study published by Google in 2022 found that pull request authors faced different levels of pushback that varied depending on the authors' demographics. According to data, they found that

  • Women faced 21% higher odds of pushback than men
  • Black+ developers faced 54% higher odds than White+ developers
  • Latinx+ developers faced 15% higher odds than White+ developers
  • Asian+ developers faced 42% higher odds than White+ developers
  • Older developers faced higher odds of pushback than younger developers

We should be more mindful about the unintentional biases, especially in a diverse workplace. By being aware of it, we can avoid unnecessary pushback in code reviews and help accelerate the process.

It's A Great Place for Learning, Not Snob

Regardless of your level of experience, working as a developer is about constant learning. Pull request is an invaluable "marketplace" for developers to communicate and exchange feedback. So make sure it's a place of respect and always aim for knowledge sharing.

For me it has always been an amazing occasion to learn about domain knowledge. Take my PR in Airbnb JavaScript Style Guide, I learned so much about ECMAScript Language Specification from a Ecma TC39 member. If he was to dismiss my request without constructive feedback, the teaching moment would have never exist.

Inaction Is Bad

I read about a blog post titled "Aggressive Code Review" by a tech lead at Instagram a year ago. He claimed that an effective code review consist of

  • decisive action ASAP
  • aiming to reduce the cost of mistakes
  • demanding small pull request and move fast

What I found refreshing in his approach is that not acting on a pull request is not an option. It minimizes the lead time to review and it has been very beneficial to me and my team. We are able to ship fast because we take proactive actions to code review. We don't let pending pull requests linger and we review with our business cases in mind.

Final Thoughts

To recap the best practices of pull request and code review to accelerate your development cycle

  • establish clear communication about the when and what of a pull request
  • create small and self-contained pull request that focus on one thing
  • be mindful about biases
  • be respectful to the author and fellow reviewers
  • take decisive review action as soon as possible

References

Also Published Here

Want to connect? This article was originally posted on Daw-Chihā€™s website.

Written by dawchihliou | I write for engineers. I write about web technology, coding patterns, and best practices from my learnings.
Published by HackerNoon on 2022/12/06
ABOUTHow hackers start their afternoons. We publish tech stories and build publishing software.

READEntirely free library read by hundreds of millions to learn anything about any technology.

WRITEHackerNoon elevates quality technology writing far and wide across the interwebs.

PARTNERHackerNoon works directly with tech companies to place ads by content relevancy