Intro to Code Reviews
- My Code Review Journey
Jonathan shares his journey to discovering the value of code reviews. He includes helpful advice for all parties in a code review system: authors, reviewers, and leaders. He covers: • What’s the goal of a code review • How to review another’s code • How to prepare your code to be reviewed by others. • Don’t be a jerk
Guidance for the Code Author
- Writing pull requests your coworkers might enjoy reading
A Twitter engineer shares advice for getting people to review your code: discuss code changes beforehand, make them small, and describe them clearly.
Guidance for the Code Reviewer
- How to Do Code Reviews Like a Human (Part One)
Michael explains what is a code review and why are they hard, and then covers 8 techniques for how to do them well: Let computers do the boring parts; Settle style arguments with a style guide; Start reviewing immediately; Start high level and work your way down; Be generous with code examples; Never say “you”; Frame feedback as requests, not commands; Tie notes to principles, not opinions
- What to look for in a code review
In Google's internal documentation for code reviews, they tell code reviewers to look for: design, functionality, complexity, tests, naming, comments, style, consistency, documentation, every line, context, & good things
- Code Review Best Practices
Kevin covers: • What I look for during a review: architecture / design, style, testing • Review your own code first • How to handle code reviews • On mindset • Addressing suggested changes
- A Guide to Mindful Communication in Code Reviews
Amy offers some tips for both code reviewers and authors on practicing mindful communication to maximize the teaching and learning value of code reviews.
Example Code Review Policies