Code Review Guide

This is a summary and adaption of Google’s Code Review Guidelines to fit our development workflows and meant to be used as an entry point and reference for reviewers and authors. Please take the time to read the Google guide (~15 min read), it contains a lot of valuable information.

Contents

• Basics
  • The purpose of code reviews
  • When to do a code review?
  • How to choose reviewers?
  • When to approve a code review?
  • Resolving Conflicts
• Responsibilities
  • Authors
  • Reviewers
  • Reviewers & Authors
• What to look for in a code review?
  • Principles
  • Design
  • Functionality
  • Complexity
  • Tests
  • Naming & Comments
  • Documentation
  • Good Things
  • Summary
• Speed of code reviews
  • How long should a code review take?
  • How to speed up code reviews
• How to write code review comments
  • Summary
  • Explain Why
  • Communicate Clearly
  • Respectful communication
  • Guidelines
• Review Checklist
  • General
  • Types
  • Memory
  • Scripting
  • Application