コードレビュー
Laravel / PHP での開発を想定しています。
コードレビュー前の心構え
1. 開放性と受け入れの意識
- レビューは改善と学習の機会であり、批判ではないという意識を持つ。
2. 尊重とプロフェッショナリズム
- レビューは尊重の精神で行う。批判はコードに対するもので、人間や能力に対するものではない。
3. 明確なコミュニケーション
- レビューのフィードバックは明確で具体的であるべき。好意的なトーンと言葉を用いる。
4. タイムマネジメント
- レビューに適切な時間を割く。長時間連続してレビューを行うと、集中力が低下する可能性があるので、適度な休憩を取る。
コードレビュー時のガイドライン
1. コーディング規約
- Laravel の公式コーディング規約を遵守します。
- 命名規則、インデント、スペース、改行、コメントのスタイルなどを統一します。
2. コードの品質
- コードは簡潔で、明確で、再利用可能でなければなりません。
- 不必要なコードや重複コードは避けます。
3. テスト
- すべての新規コードには適切な単体テストが伴います。
4. ドキュメンテーション
- コードには適切なコメントが含まれているべきです。
5. パフォーマンス
- コードは効率的に動作するようにします。
6. セキュリティ
- Laravel のセキュリティベストプラクティスを遵守します。
7. プルリクエスト(PR)の作成
- PR は一つのタスクやバグ修正に対応するようにします。
- PR の説明には変更の目的と詳細を記述します。
8. 静的コード解析ツールの利用
- PHPStan や Psalm などの静的コード解析ツールを利用します。
9. フィードバックの提供
- レビュワーはコードの問題点を明確に指摘し、可能であれば改善策を提案します。
10. 継続的な学習
- チーム全員が最新の PHP と Laravel の機能、ベストプラクティス、セキュリティ更新について継続的に学習します。
コードレビューの手順
1. 準備
- レビューが必要なプルリクエスト(PR)の目的と内容を理解するため、PRの説明を読む。
- 関連するタスクやバグ報告を確認する。
2. 全体の理解
- PR全体を一通り読み、大枠の理解をする。
3. 詳細なレビュー
- コーディング規約、コードの品質、テスト、ドキュメンテーション、パフォーマンス、セキュリティに注意を払う。
- PRの変更が要件を満たしているか確認する。
4. フィードバックの提供
- 問題点を見つけたら、具体的で明確なフィードバックを提供する。
- 可能であれば、改善のための提案も行う。
5. 再レビュー
- フィードバックに対する修正が完了したら、再度レビューを行う。
- 修正が適切に行われ、問題が解決されていることを確認する。
6. 承認
- 全ての問題が解決されたら、PRを承認する。
- 必要であれば、最終的なコメントやフィードバックを提供する。