Code Review

Question 1

What structured approach to code reviews can we use?

Answer 1

1. Start by explaining your process and best practices. (See Google Code Reviews)
2. Read entire code and understand. Ask clarifying questions
3. Do a line by line review and identify potential: Bugs, Performance, Readability, Logging Exception Handlling
4. Data structures, Time & Space Complexity

Question 2

What is the first rule of code reviews?

Answer 2

A PR should be approved when it is in a state where it improves the overall health of the system being worked on. Even if it isn’t perfect.

Question 3

Why are code reviews important?

Answer 3

1. Ensure system quality and health.
2. Mentoring and helping engineers level up
3. Solidifying team standards

Question 4

How to handle style disputes?

Answer 4

The style guide is the absolute authority.

Question 5

What to look for in a code review?

Answer 5

• Design
• Functionality
• Complexity
• Operating in production
• Tests
• Naming
• Comments: Why code exists, not what the code does.
• Style / Consistency
• Documentation