code-review

コードレビュー

コードをレビューする際は、以下のガイドラインに従ってください。

レビューチェックリスト

問題の特定

コード変更で以下の問題を探してください。

• 実行時エラー：例外の可能性、ヌルポインターの問題、範囲外アクセス
• パフォーマンス：上限のない O(n²) 処理、N+1 クエリ、不要なメモリ割り当て
• 副作用：他のコンポーネントに影響する意図しない動作変更
• 後方互換性：移行手段のない API 変更による破壊
• ORM クエリ：予期しないクエリ性能を招く複雑な Django ORM
• セキュリティ脆弱性：インジェクション、XSS、アクセス制御の不備、シークレットの漏洩

設計の評価

• コンポーネント間の連携は論理的ですか？
• 変更は既存のプロジェクトアーキテクチャに沿っていますか？
• 現在の要件や目標との矛盾はありませんか？

テストカバレッジ

すべての PR に適切なテストカバレッジが必要です。

• ビジネスロジックの機能テスト
• コンポーネント間の連携を確認する統合テスト
• 重要なユーザーパスのエンドツーエンドテスト

テストが実際の要件とエッジケースを網羅していることを確認してください。テストコード内で過剰な分岐やループを避けてください。

長期的な影響

以下を含む変更は、シニアエンジニアによるレビューの対象として指摘してください。

• データベーススキーマの変更
• API コントラクトの変更
• 新しいフレームワークやライブラリの採用
• パフォーマンスが重要なコードパス
• セキュリティ上重要な機能

フィードバックのガイドライン

口調

• 礼儀正しく、相手の気持ちに配慮してください
• 曖昧な批判ではなく、実行可能な提案をしてください
• 不確かな場合は、「〜を検討されましたか？」のように質問として表現してください

承認

• 軽微な問題のみが残っている場合は承認してください
• 文体上の好みを理由に PR をブロックしないでください
• 目標は完璧なコードではなく、リスクの低減であることを忘れないでください