Pair Programming and Code Reviews

18 Sep 2016 . development practices . Comments #pair programming #extreme programming

Pair programming has long been considered a replacement for code reviews. If code was written in a pair, having a code review was considered unnecessary and even wasteful. I held onto this belief for a long time even when faced with the fact that there were specific scenarios where it failed me and my team. I have even mentioned it in previous blog posts.

The twelve XP practices are brilliant and I contend that they would dramatically improve any development team that took the time to master them. I am a huge proponent of XP (including Pair Programming) and it remains one of my passions. However, there are a lot of cases where I do not think pair programming should be considered a substitute for a code review.

There is still a contingent of people who believe this. I often see blog posts recommending increasing team efficiency by replacing code reviews with pair programming. I even saw a conversation between some of the original XP practitioners stating that the pull request and code review model was wasteful for teams that pair program. Being on a team that does both I have to disagree. I have found that combining these practices have been incredibly valuable for my team.

The Twelve XP Practices
Pair Programming
Planning Game
Test Driven Development
Whole Team
Continuous Integration
Design Improvement
Small Releases
Coding Standard
Collective Code Ownership
Simple Design
System Metaphor
Sustainable Pace

Advice of the Time

The advice at the time wasn’t bad. When compared to the standard practices at the onset of agile and XP, it was a dramatic improvement. In fact, you still don’t have to look very hard to find development organizations working without any code reviews or organizations that require code reviews for “junior developers” but “senior developers” get away without having any reviews of their code before it goes into production.

When developers work by themselves all too often their code gets shipped into production without any feedback whatsoever. Furthermore, organizations levying unrealistic deadlines on the team only serves to make the problem worse. In these cases developers are racing to meet deadlines and hacking code together to get something that “works” into production. This is terribly short-sighted because the maintenance cost of that code is a non-insignificant, ongoing tax for the organization. The total cost of that original code change is significantly higher than slowing down and delivering high quality (i.e., easily changeable) code the first time. Sadly, some organizations are just still too short-sighted to understand the trade off they are making.

A Response to Big Code Reviews

Even when teams did practice code reviews they were often held at the very end of a large project. They were usually held as large meetings where the attendees had to be interrupted to attend the meeting in person. The expectation is that the attendees have spent a significant amount of time pouring over huge amounts of code so that they can provide detailed advice and recommendations during the meeting.

This practice fails for a number of reasons. It is often way too late in the development cycle to give anything more than trivial feedback. Any significant changes would typically cause the developer massive amounts of rework. This presumably would put them well behind their schedule and increase the pressure on them for the duration of the project. This frustrates both the author and the reviewer; feeling that these meetings are a waste of time. It is nearly impossible for someone to be able to give a detailed and high-quality review of such large amounts of code. Typically a large number of issues slip through the cracks when having code reviews of this magnitude.

Given that this practice was standard for the time, the recommendation that pair programming could replace these problematic practices was indeed true. Pair Programming was certainly an improvement over this.

Enter Github and Pull Requests

In the last several years Github has brought us the concept of pull requests. They are the core component of the Github Flow. Using a pull request flow (and some discipline to keep commits small) teams can overcome the challenges of the traditional code review. While there are tools that existed prior to Github that allowed teams to review code asynchronously before being committed to a repository, Github’s model has had a much wider adoption.

As long as teams are issuing pull requests for small amounts of code (small, incremental divergences from their master branch) they can get asynchronous feedback on their code in a positive way prior to it being merged into their master branches. They can get this feedback at the appropriate time in their project and with enough time to respond to it. It is this practice combined with pair programming that I contend has benefits.

It Depends

Like nearly all things in software development if someone would ask me if pair programming is a substitute for code reviews my answer would be, “it depends.” There are some cases where I think it can work. Specifically when a team has worked together for a significant amount of time and have a thorough understanding of their coding standards. However, my belief is that in general there is still a significant benefit to having code reviews even when practicing pair programming.

The Issues with Skipping Code Reviews

For the majority of the ten years I have practiced pair programming, my teams skipped code reviews if the code was created in a pair. I am going to describe the issues associated with that practice in this article.

Coaching

When new team members were brought on some were new to the domain, some were new to our technologies, most were new to our development practices, and some were new to all three! In each of these cases the pairing session was very different than when a pair of more experienced developers worked together. The focus of these sessions was split between getting the task accomplished as well as coaching the new team member. Coaching is a fantastic usage of pair programming and one of the great benefits of teams regularly practicing it. However, the problem arises when this code is not reviewed by the rest of the team because it was “paired on.” Problems were found coming out of “coaching pair code” because it was worked on by only one team member who had experience in the codebase while they were also trying to coach a new team member.

Splitting the experienced developer’s focus between accomplishing the task and coaching a new developer is, at times, too much to juggle in a pairing session. That can manifest itself as reduced quality code. When coaching, the information is usually being communicated in one direction, from the more experienced developer to the new developer. In contrast, when two experienced developers pair, they are constantly exchanging ideas typically resulting in a better solution.

Junior Pairs

At one point the company I worked for decided that we needed additional development staff to accomplish our goals. During this time we also lost some key senior developers. This resulted in doubling our development team in an extremely short period of time. This created an environment where we had four experienced developers and four new developers on the team. The result was very problematic for the quality of our code. On a typical day this meant that every pair was engaged in coaching. While again, I believe this was good for the new members to come up to speed, we were getting very little value out of the pairing session other than coaching.

Even more problematic were the situations that would arise when one of the experienced developers was sick, on vacation, or in a meeting. In these cases, two new developers would pair together and all too often would not know when to stop and ask questions. The team would have to come back and fix a fair amount of code towards the end of the iteration after the junior pair had already committed the code to the master branch.

Author vs. Editor

The last example I wanted to discuss is something that Bryan Helmkamp, founder and CEO of Code Climate, described in his Baruco 2013 Conference, Building a Culture of Quality. In his talk he states that every author requires a great editor. As professional developers, we should be taking the same approach with code reviews. In fact, while code reviews are absolutely useful for finding issues in the code, I think they are even more useful to ensure that the code’s intent is easy to understand by someone who did not author it. It is this editing stage that helps ensure the code is as clear and concise as possible.

When a pair of developers work on the code they both share the “author’s mind” and because of this, they cannot act as an effective editor. They have both spent a significant amount of time thinking about the problem in detail while writing the code and cannot effectively see code as a new developer would when they first encounter it.

It is for these reasons I believe combining pair programming and code reviews is ideal and eliminates a lot of these problematic situations.

Benefits

Ongoing Quality Discussions

While code reviews address the problems listed above, it also introduces a very important benefit. Because these small code reviews will happen several times per day, the team will get very comfortable regularly discussing code quality and team standards. Learning how to have these discussions in a productive manner helps build trust on a team.

Coding Standards

Additionally, these regular reviews allow for teams to create coding standards and style guides. These reviews should be used to ensure that the code meets the team’s standards, and results in all of the code created by the team looking like it was written by a single developer.

Our Process

My team pairs on a majority of production code as a team rule. There are exceptions, but they are just that, exceptions not the rule. We have combined this practice with issuing pull requests to get our code reviewed and merged into our master branch. This practice has some similarities to the Github Flow but differs in one very important aspect. We create these very short lived branches to facilitate asynchronous code reviews, only. We ensure that these branches live for less than a day so that we can continue to practice Continuous Integration.

A pair of developers will pick a task for the highest priority user story that is currently in progress. They will make sure that they can work on the task without interfering with another pair, or they will start a task associated with the next highest priority story. Once they begin development, they create a branch off of our master branch. When the task is complete they issue a pull request back to the master branch. Every other developer on the team is included on the pull request. The pair addresses pull request comments in their branch and get at least two approvals before merging their code back into the master branch.

Even though we pair, we still get great comments and have valuable conversations about the code through our code review process. In fact, comments that come out of the pull request will often be used as a conversation to determine if we want add to or modify our coding standards.

Conclusion

I find that pair programming results in significantly higher quality code, is great for building trust on a team, and very beneficial to share knowledge across a development team. However, I have found that pairing alone is not a replacement for code reviews. The combination of the two has had a positive affect on my team and the quality of our software. Code reviews help foster a team’s long-term, continued focus on quality and the continuous improvement their code.