[SVN] Peer Code Review

I remember sitting in on code reviews early in my career. You took your code, put it up on a projector, and the architects—shadowy figures in the back of the room—ripped it to shreds. These marathon sessions would take all day and were completely exhausting. They certainly improved the code, but they wreaked havoc with both release schedules and people’s psyches!


Nowadays, I do code reviews a little differently. Instead of submitting our code to the senior architects, we do peer code reviews. Here’s how it works:
  • I go away and write some code, including tests for that code.
  • I run all the tests and tweak until I’m happy with the work. It functions, it’s structured properly, it conforms to all of our style requirements, and it’s got a really clever solution to that sorting problem.
  • I commit the code to my feature or developer branch. It’s not in mainline code yet, and won’t ship (this is important!).
  • I ask for review. If we’re working in Git, then I do it by creating a pull request. If we’re using some other source code management system, then I just ask for it based on the commit number, or create a patch.
  • Someone else on the teamworking in Git—might be the senior engineer, might be the intern—takes a look at the code. They look for bugs, structural problems, unintentional duplications, or any of the mistakes we developers commonly make.
  • I fix any problems brought up in the code review, or talk with the reviewer about why I did it that way. Repeat until we’re both happy.
  • One of us merges the code and checks it in.
If that’s the structure, what on earth are we doing? And what does an intern know about how we do things?
That’s actually the point. Code reviews aren’t about approval—they’re about learning. A peer code review provides a forum to spread knowledge around the team, including important things like how this feature works, or what patterns make sense.
It also provides a way to cover each other. Every one of us has a set of common mistakes that we make, and those mistakes aren’t the same as the mistakes our peers make. Doing a peer code review lets me catch that dumb thing that Jake always does, and let’s Jake catch that stupid error I always make, and it does it in a casual, non-accusatory forum.
Last, peer code reviews are deliberately done among equals. Anyone can review anyone else’s code, from the most junior to the most senior engineer on the team; it eliminates the ego and the defensiveness from code reviews.
Sounds great!

Comments

Post a Comment

Popular posts from this blog

[SVN] Simple way to do code review

Image
Simple way to do code review Table of Contents A code review (also known as code inspection or walkthrough ) is often considered to be a complex, time consuming and highly regulated process. In reality it’s just another form of communication between team members and a great way to ensure code quality and stay up to date with changes. In this guide we will show a simple and effortless way to do it on a daily basis. Use version control We hope you are already doing this! Version control systems make any work inside your team much easier, and this includes code reviews. Check out our guide “Introduction to version control” if you are still managing code the old-fashion way, or are interested in learning some best practices. Stay up to date Email and RSS are common ways to be notified about new things and code changes are not exceptions. Depending on the project scope and team size you can choose between checking every commit or just doing review o
Read more

How to Choose a Technology Stack for Web Application Development

Image
What’s the most important thing to consider when you’re developing a top-notch web application? No doubt it’s the technology stack your app will be based upon.  The choice of a relevant tech stack is particularly challenging for small businesses and startups, since they usually have limited budgets and, thus, need a technology stack that provides the most bang for the buck to get their projects off the ground. The right tech stack is, to a great extent, the key to your project’s success, while the wrong choice of web development technologies may be a reason for failure. We’ve decided to give you a helping hand and reveal the criteria for choosing the most appropriate tech stack for your web application. WHAT IS A TECHNOLOGY STACK FOR WEB DEVELOPMENT Before moving on to the criteria for choosing a modern web technology stack, you should clearly understand what comprises the process of web development. Without going too deep into details, there are two sides to web de
Read more

Setting ESLint on a React Typescript project

Image
  Introduction After struggling a lot trying to install and understand ESLint on my React Typescript project, I decided to create a definitive guide to setting ESLint to a React Typescript project. The main goal of this tutorial is to set up step-by-step and explain every line added or executed, instead of just giving you a bunch of files with a lot of configurations and expecting that you will be able to understand what and how things are happening. So, let’s start! Prerequisites Note: You need Node version >= 10 installed. So, if you don’t have it, please go to the NodeJS website, and download and install it on your local machine. ( https://nodejs.org/en/ ) Step 1: Create a React Project with Typescript The following command will create a project inside a folder  my-app . On the terminal, run: npx create-react-app my-app --template typescript Step 2: Removing the pre-set ESLint configuration from React project React comes with an eslint configuration pre-setted. Let’s remove this
Read more