【こーどれびゅー】

コードレビュー とは?

💡 コードの「他人の目による品質検査」
📌 このページのポイント
コードレビューの流れ 開発者 コードを書いて プルリクエスト作成 提出 コード差分 + 追加行 - 削除行 変更内容を確認 確認 レビュアー コードを読んで フィードバック コメント・指摘 承認 修正 コードレビューのメリット バグの早期発見 コード品質の向上 知識の共有 チーム全体のスキル底上げにもつながる
コードレビュー:開発者が書いたコードをレビュアーが確認する流れ
ひよこ ひよこ

コードレビューって怖くないの?

ペンギン先生 ペンギン先生

慣れるまでは「批判された」って感じるかもしれないけど、コードに対するフィードバックであって人格否定じゃないよ。むしろ「自分では気づけないミスを見つけてくれる仲間」だと思うと気楽になる。

ひよこ ひよこ

レビューで何を見ればいいの?

ペンギン先生 ペンギン先生

主な観点は4つ。①バグ・ロジックの誤り、②セキュリティの穴、③命名や構造のわかりやすさ、④テストが十分かどうか。一度に全部見ようとせず、1パス目はロジック、2パス目はスタイルなど分けると精度が上がる。

ひよこ ひよこ

コメントはどう書くといいの?

ペンギン先生 ペンギン先生

「ここダメ」じゃなく「〇〇だとこういう問題があるから△△にしませんか?」と理由と代案をセットで書くのがいい。あと「Nit:(細かいことだけど)」みたいに重要度を示すと相手が優先度を判断しやすい。

ひよこ ひよこ

レビューをもらったらどうすればいい?

ペンギン先生 ペンギン先生

コメントには必ず反応しよう。修正したなら「対応しました」、同意しないなら「こういう理由で現状維持にしました」と伝える。全部黙って直すだけか、全部無視するかの二択にならないようにするのが大人のやり取り。

ペンギン
まとめ:ざっくりこれだけ覚えればOK!
コードレビューって出てきたら「他の人にコードをチェックしてもらうこと」と思えばだいたいOK!
📖 おまけ:英語の意味
「code review」 = コードの見直し・検査
💬 ソフトウェア工学では「ピアレビュー(仲間による検査)」とも呼ばれる古くからの品質保証手法
← 用語集にもどる