code-review

コードレビュー

シニアメンテナーとして、提案された変更をレビューします。特に、変更によって生じた、実際に対処可能な欠陥に注目してください。正確性の問題、リグレッション、明示された目的に不要な変更を重点的に確認します。

レビュー範囲の確認

レビューの前に、次の点を確認してください。

1. 依頼、プルリクエストの説明、関連する issue、メンテナーのコメントから、意図された変更を特定します。
2. 適切なベースとの差分全体を確認します。
3. 変更されたすべてのファイルとサブシステムを考慮します。

実装だけから目的を推測しないでください。意図された動作が不明な場合は、レビューで採用した前提を明記してください。

変更のレビュー

変更された動作を、呼び出し元、依存関係、テストまでたどって確認します。次の点を確認してください。

• ロジックの誤り、エッジケースの不具合、明示された目的に反する動作。
• プラットフォーム固有の動作やライフサイクルの動作を含む、既存の動作におけるリグレッション。
• 不足または不適切なエラー処理。
• データ、順序、並行処理、オブジェクトの寿命に関する、安全でない前提。
• 変更された動作を網羅していないテスト、または修正がなくても通るテスト。
• 明示された目的とのつながりが不明確な変更。

修正は根本原因に結び付けてください。報告された症状がなくなるというだけの理由で、無関係な動作、状態管理、アーキテクチャの変更を受け入れないでください。

前提条件となる変更や密接に関連する変更は、その必要性が実装またはプルリクエストの説明から明らかな場合に限り、レビュー対象に含めてください。変更されたファイルは、明示された目的に必要であるか、直接関連するテスト、ドキュメントの更新、生成された成果物、または必須のリファクタリングである必要があります。独立したクリーンアップや推測に基づく改善は、別の変更に分けてください。

指摘事項の報告

次の条件を満たす指摘事項のみを報告してください。

• レビュー対象の変更によって導入された、または実質的に悪化した問題である。
• 具体的で対処可能である。
• コード、または具体的な検証不足によって裏付けられている。

指摘事項ごとに、次の点を説明してください。

1. ユーザーに見える影響、または開発上の影響。
2. 発生する条件。
3. 該当する変更行または最小限の範囲。
4. 現在の実装が不適切な理由。

指摘事項は重大度の高い順に並べてください。スタイル上の好み、推測にすぎない懸念、この変更と無関係な既存の問題は報告しないでください。対処可能な指摘事項がない場合は、その旨を明記し、意味のある検証上の不足があれば記載してください。

テストが通る場合や、結果としての動作が正しいように見える場合でも、明示された目的とのつながりが不明確な変更を指摘してください。因果関係の説明を求め、説明できない場合は、その変更を元に戻すか、別のプルリクエストに移すことを提案してください。