コードレビューのススメ
概要
コードレビューについて、個人的な考えをまとめてみるページです。
目的
コードレビューは主に下記の点を期待して実施しています。
- 開発・運用方法のナレッジ共有
- システム変更の周知
- 他者に見られることによる、成果物の品質向上
レビューイの心得
あなたが主役です
タスクの担当者はあなたであり、結果の成否はあなたが握っています。
たとえレビュワーの指摘で直したとしても、レビュワーには責任はありません。
当事者意識を持ち、指摘をそのまま反映するのではなく、自身で判断して修正してください。
承認をもらうのが目的ではありません
チームによって、POの承認必須や１人以上の承認必須と決まっている場合もあるかもしれません。
それはルールに沿って運用してもらえればいいのですが、承認をもらうのが目的になるとレビューが形骸化します。
自分で気づけなかったポイントを指摘してもらい、事故を未然に防ぎ、チームから知識を引き出す事がより重要だと思います。
そのために必要だと思う人物がいれば、チーム外の人であろうとレビュワーに追加しましょう。
説明をしましょう
タスクについて一番詳しいのは、担当者のあなたです。
レビュワーの指摘が間違っていれば、間違っている点を説明してください。
指摘を解決しましょう
レビュワーの指摘を解決しないまま、リリースしないでください。
コードを修正するか、修正しない理由をコメントしてください。
無視してリリースするのは、レビュワーに対して失礼です。
依頼の前に自己確認を
レビューを依頼する前に、差分を一度確認してください。
ぱっと見で分かるような指摘をレビュワーにさせずに、有意義なレビューにしましょう。
レビューは品質を保証しません
レビューを行ったからといって、成果物の正当性は保障されません。
必ずSTGでテストして、リリースに望んでください。
レビュワーの心得
まずは参加してみよう
レビュワーに指定されていなくても、対象のシステムについて詳しくなくても構いません。
気になったポイントがあれば、気軽に質問してみましょう。
間違いを恐れない
レビュワーとして参加し続ける場合、間違った指摘をしてしまう事は必ずあります。
間違っていたら素直に非を認めて、次にいきましょう。
強い言葉を使わない
最初から強い言葉は使わない方がいいと思います。
仕様認識に齟齬がある場合もありますので、まずは理解できない点を質問してみましょう。
完璧を求めない
あなたの完璧は、他の人にとって完璧とは限りません。
重要ではないポイントであれば、細かい指摘に終始しないように気をつけましょう。
最後に、みんな仲良く楽しみましょう！
『みんな、 仲良くプレイしましょう！』 by 某遊戯の神
Discussion