Code Reviews

Code review guidelines specific to Orbital Kitchens practices and patterns.

Before Submitting a PR

Link to Linear ticket in PR description.

Reviewer Guidelines

Orbital-Specific Focus: Standards compliance (TODO format # TODO [ORB-XXX]: Description), RabbitMQ/Protobuf patterns, database-specific concerns (MongoDB, PostgreSQL, Snowflake).

Approval Process

CRITICAL: Always ensure someone approves your PR before merging. We practice cross-validation - at least one team member must review and approve. Do not merge your own PRs without approval.

Approve if: All blocking comments addressed, code meets quality standards, tests pass in CI/CD, no security concerns, PR description clear and complete.

Request Changes if: Security issues, logic bugs, standards violations, insufficient test coverage, undocumented breaking changes, unclear documentation/code.

Common Issues to Watch For

RabbitMQ/Protobuf: Never edit *_pb2.py files (generated from .proto files in shared/proto/). Handle connection errors gracefully, ensure proper message acknowledgments, handle serialization errors.

Database-specific: - MongoDB: Missing indexes, unhandled connection failures, overly broad queries - PostgreSQL: Missing indexes, N+1 query problems, improper connection pooling - Snowflake: Inefficient queries, inappropriate warehouse sizes, missing query timeouts

Resources

• Best Practices
• Architecture Overview
• Team Resources: Communication channels and team documentation
• Example Engineering Design Doc

Review Checklist

Orbital-Specific Standards: TODO format # TODO [ORB-XXX]: Description, RabbitMQ/Protobuf patterns, database-specific concerns (MongoDB, PostgreSQL, Snowflake).

---

Last Updated: 2025-10-21