コードレビュー時に意識するべき観点を、最下部の資料からまとめました。
自分への戒めとして、記しておきます。
考慮に入れるべきこと
レビューの目的はなにか、チーム内でコンセンサスを取る
- 「コードレビューが完了したときに、どういう状態になっていれば成功なのか」を意識する。
- 指摘を受けて修正する場合、優先順位を検討する。
- 自分の指摘にはどれくらい実現可能性があるか
- 指摘を反映した場合に、プロジェクト全体にどんなメリットがもたらされるか
- ソースコードの基本は、「将来的に必要になる修正・対応コストを削減する」こと。
- メンバー同士の知識がチームに共有されることで、技術レベルが向上する
「どんな勉強をすれば、コードレビューで受けた指摘を改善しやすくなるか」もセットで教える
初学者は、どういう勉強をすればいいかそもそもわからない場合があるので、学習方法についても案内する。
また、パブリックな場で教えることで、知識を共有し合う文化の形成につながる。
ソースコードのいい部分には「いいね！」という
良いコードやいい指摘を目にしたら、積極的に「いいね」とコメントする。
フィードバックとは、悪い部分を改善するためだけではなく、いい部分を伸ばすためにでもある。
「最悪を最初に」
影響範囲が広い、手戻りコストが高くつく、失敗するようなリスクがないか確認する。
残りを適切な順序でみる。
資料
-
コードレビューを成功させるためにCTOが考えるべき7つのことー監修：高遠和也（株式会社LIG CTO） | FLEXY（フレキシー）
https://flxy.jp/article/4298 -
コードレビューのイロハをまとめました（レビュイー/レビュアー両者の心得や実践的なテクニックなど） - Qiita
https://qiita.com/hariNEzuMI928/items/5e3d96a069e075e37720