reviewing-code

Code Review

Philosophy

Code review maintains a healthy codebase while helping contributors succeed. The burden of proof is on the PR to demonstrate it adds value. Your job is to help it get there through actionable feedback.

Critical: A perfectly written PR that adds unwanted functionality must still be rejected. The code must advance the codebase in the intended direction. When rejecting, provide clear guidance on how to align with project goals.

Be friendly and welcoming while maintaining high standards. Call out what works well. When code needs improvement, be specific about why and how to fix it.

What to Focus On

Does this advance the codebase correctly?

Even perfect code for unwanted features should be rejected.

API design and naming

Identify confusing patterns or non-idiomatic code:

• Parameter values that contradict defaults
• Mutable default arguments
• Unclear naming that will confuse future readers
• Inconsistent patterns with the rest of the codebase

Specific improvements

Provide actionable feedback, not generic observations.

User ergonomics

Think about the API from a user's perspective. Is it intuitive? What's the learning curve?

For Agent Reviewers

1. Read the full context: Examine related files, tests, and documentation before reviewing
2. Check against established patterns: Look for consistency with codebase conventions
3. Verify functionality claims: Understand what the code actually does, not just what it claims
4. Consider edge cases: Think through error conditions and boundary scenarios

What to Avoid

• Generic feedback without specifics
• Hypothetical problems unlikely to occur
• Nitpicking organizational choices without strong reason
• Summarizing what the PR already describes
• Star ratings or excessive emojis
• Bikeshedding style preferences when functionality is correct
• Requesting changes without suggesting solutions
• Focusing on personal coding style over project conventions

Tone

• Acknowledge good decisions: "This API design is clean"
• Be direct but respectful
• Explain impact: "This will confuse users because..."
• Remember: Someone else maintains this code forever

Decision Framework

Before approving, ask:

1. Does this PR achieve its stated purpose?
2. Is that purpose aligned with where the codebase should go?
3. Would I be comfortable maintaining this code?
4. Have I actually understood what it does, not just what it claims?
5. Does this change introduce technical debt?

If something needs work, your review should help it get there through specific, actionable feedback. If it's solving the wrong problem, say so clearly.

Comment Examples

Good comments:

Checklist

Before approving, verify:

• All required development workflow steps completed (uv sync, prek, pytest)
• Changes align with repository patterns and conventions
• API changes are documented and backwards-compatible where possible
• Error handling follows project patterns (specific exception types)
• Tests cover new functionality and edge cases
• The change advances the codebase in the intended direction