Review Workflows

Philosophy: Fast feedback, high quality, knowledge sharing

Overview

Code review is critical for maintaining quality, catching bugs early, and sharing knowledge across the team. This directory contains templates and guidelines for effective code reviews.

Files in This Directory

• pr_template.md - Standard pull request template
• review_checklist.md - Comprehensive review checklist
• review_etiquette.md - How to give/receive feedback kindly
• approval_process.md - Approval requirements and workflow

Quick Start

For Authors

1. Keep PRs small (< 400 lines ideal)
2. Use PR template
3. Self-review before requesting review
4. Respond to feedback within 24 hours

For Reviewers

1. Review within 24 hours
2. Use review checklist
3. Follow etiquette guidelines
4. Approve if no blocking issues

Key Principles

1. Be kind - Critique code, not people
2. Be specific - Vague feedback helps no one
3. Be prompt - Don't let PRs sit
4. Be thorough - But don't nitpick
5. Be collaborative - Reviews improve both code and engineers

Related Documentation

• Communication Setup
• Project Management