Cracking the Code Review: from Guesswork to Automated Guidance by Paco van Beckhoven

Code reviews are crucial for finding bugs early, fostering code quality, and sharing knowledge between team members

Automate as much as possible to reduce manual review effort:

• Use code formatters (Google Java Format, Spotless)
• Implement static analysis tools (Error Prone, ArchUnit)
• Enable code coverage reports in PRs
• Set up automated linting and style checks

Write clear, descriptive pull request titles and descriptions:

• Include context and motivation for changes
• Add relevant screenshots or examples
• Link to related tickets
• Use templates to ensure consistency
• Add checklists for reviewers

Review your own code first:

• Check for style issues
• Run tests and verify coverage
• Look for potential bugs
• Review your own changes in your IDE

Focus on important aspects during review:

• Start with design and architecture
• Review tests thoroughly
• Look for security issues
• Avoid bike-shedding on formatting
• Keep discussions constructive

Use positive and collaborative language:

• Frame feedback as suggestions rather than commands
• Use “we” instead of “you”
• Acknowledge good work
• Be specific in feedback
• Take discussions offline for complex issues

Make reviews manageable:

• Keep PRs small and focused
• Review promptly to avoid context switching
• Consider breaking large changes into smaller PRs
• Prioritize reviews based on urgency

Foster a positive review culture:

• Share responsibility for code quality
• Help junior developers gain confidence
• Learn from each other’s feedback
• Celebrate good contributions