Code Review¶

Code Review Overview¶

Why Code Review Matters

What to Review¶

Code Review Checklist

Giving Effective Feedback¶

Feedback Guidelines

Comment Examples¶

// BAD Comments:

"This is wrong."
"Why did you do it this way?"
"This is confusing."
"Fix this."

// ─────────────────────────────────────────────────────────────

// GOOD Comments:

"🔴 Blocker: This query runs in a loop and could cause N+1
issues with large datasets. Consider using a batch query
or join instead. Happy to pair on this if helpful."

"🟡 Suggestion: We could simplify this by using
Optional.map() here:
```java
return user.map(User::getName).orElse("Unknown");

Not a blocker, but would improve readability."

"💬 Question: I'm curious about the decision to use a HashMap here instead of TreeMap. Is ordering not important for this use case?"

"👍 Really clean implementation of the retry logic! I like how you extracted it into a reusable component."

"🟢 Nit: Per our style guide, we typically use camelCase for variable names (userCount instead of user_count)."

---

## Code Review Workflow

![Review Process](../images/engineering/review-process.svg)

---

## PR Description Template

```markdown
## Summary
[Brief description of what this PR does]

## Motivation
[Why is this change needed? Link to ticket/issue]

## Changes
- [Change 1]
- [Change 2]
- [Change 3]

## Testing
- [ ] Unit tests added/updated
- [ ] Integration tests added/updated
- [ ] Manual testing performed

## Screenshots
[If applicable, add screenshots]

## Deployment Notes
[Any special deployment considerations]

## Checklist
- [ ] Code follows style guidelines
- [ ] Self-review completed
- [ ] Documentation updated
- [ ] No security vulnerabilities introduced