コード・レビュー
この文書では、案件におけるコード・レビューの方針について規定します。
2段階のレビュー
コード・レビューは以下の2段階で行います。
- 開発者によるセルフレビュー
- レビュアーによるコードレビュー
開発者によるセルフレビュー
他の開発者にレビューを依頼する前に、セルフレビューを行います。これは以下の理由により、開発者自身による入念な品質保証が要求されるためです。
- QA専任者が原則アサインされません
- コード・レビューでは原則的にコード上の差分確認のみ行われ、画面操作やプログラム実行による動作確認を必須としません
- 本番環境での動作確認では、主要な操作のみに限定される場合があります
そこでセルフレビューでは、以下の活動を行います。
- 差分へのコメント
- 実装が検査仕様を充足するか確認
- デモ動画とエビデンスの添付
1. 差分へのコメント
Pull Requestの差分に対して変更意図をコメントします。軽度な変更や自明な変更についてはコメントをスキップできます。この時、ソースコードのコメントとして記述した方が良いものであればそのようにして下さい。
2. 実装が検査仕様を充足するか確認
3. デモ動画などのエビデンスの添付
セルフレビューの完了後、開発者の
「開発者によるセルフレビュー」と「レビュアーによるコードレビュー」の2段階で開発成果物の品質を担保します。
したがって、開発者による
QAの専任者はアサインされません。またコードレビューにおけるQAは、レビュアーの責務外とします（レビュー過程で問題を見つけ指摘することは当然可能です）。品質保証は開発者自身が行うものとします。