今回は、コードレビューの基本として、その目的を整理したいと思います。コードレビューの主な目的と、それぞれの目的に合わせたレビューアプローチを解説します。
レビューをなぜやるのか、明確に言えますか？
自分たちのチームにおけるコードレビューの目的を明確に挙げられますか？コードレビューへの期待値はさまざまにありますが、それを共有していないと効率的なコードレビューにはなり得ません。見る必要な部分まで見ようとして時間と負荷がかかってしまう、逆に見るべき部分を見落としてしまって、不具合や設計の問題が発生してしまうなど、さまざまな問題が起こります。
本記事では、コードレビューの主要な目的を挙げ、それぞれの目的に応じたレビューアプローチを解説します。チームでコードレビューの目的を共有し、認識を揃えることが、効率的なコードレビューの第一歩です。
コードレビューにある4つの主要な目的
コードレビューの目的としては、大きく分けて4つの観点があります。
- 品質保証
- ナレッジ共有
- チーム連携・標準化
- 保守性向上
品質保証
コードの正確性、健全性を保つのを目的としたレビューです。具体的には以下のような観点があります。
- バグの発見
プログラマーの見逃したミスやロジック上の誤りを見つける - セキュリティ、パフォーマンスの確認
ロジックにセキュリティホールが含まれていないか、パフォーマンスに問題がないかを確認する
コードレビューにバグの発見を期待する場合、レビューは早期である方が効果的です。実際にできあがったコードに不具合があるかどうか判断するのは、本来テストにて行われるべきものになります。そのため、実際にコードを書く前に設計上のミスが確認したり、モブレビューを通して確認すると、早期の不具合発見につながるでしょう。
ナレッジ共有
チーム内でのナレッジ共有の手段として、コードレビューを行います。具体的には以下のような観点があります。
- コードの意図や背景の共有
コードの書き方や設計の意図を共有し、チーム全体の理解を深める - 開発者のスキル向上
コードレビューを通じて、他のメンバーの技術や知識を学ぶ
同じシステムを開発している場合でも、メンバーごとに得意な分野や知識が異なります。コードレビューを通じて、他のメンバーの技術や知識を学び、チーム全体の知識共有を促進します。また、ジュニアレベルのエンジニアに対して、コードレビューを通じて教育的なフィードバックを行い、スキル向上を図ります。
チーム連携・標準化
チーム内での連携や標準化を目的としたレビューです。具体的には以下のような観点があります。
- 設計・実装方針の整合性確保
コーディング規約や設計方針との一致を確認します - コードの受け入れ判断
コードをメインのリポジトリに取り込むかどうか最終判断します
多くの開発チームではコーディング規約を用いて、コードの書き方や設計の方針を統一しています。コードレビューを通じて、これらの規約に従っているかを確認します。また、担当者以外のチェックを入れることで、最終的にコードをマージするかどうかを判断するのは大事です。
保守性向上
コードの保守性を向上、維持することを目的としたレビューです。具体的には以下のような観点があります。
- コードの可読性
コードの可読性を高め、将来のメンテナンスを容易にする - 再利用性の向上
コードの再利用性を高め、重複コードの削減を図る
コードが技術的負債にならないよう、可読性や再利用性を意識したレビューを行います。特にチーム開発時には、他のメンバーが保守したり、さらなる開発を行うことを考慮し、コードの可読性や再利用性について確認します。トリッキーなコードが入り込むのを防いだり、適切にコメントが書かれているかを確認したりするのも大事です。
目的ごとのレビューアプローチ
では各目的に適合するレビューアプローチを解説していきます。
- 品質重視
- 教育重視
- 文化重視
- 保守性重視
品質重視
品質を重視してレビューを行う場合、他のものと比べて技術的な観点での細かいレビューが求められます。具体的には以下のようなアプローチがあります。
- コードの正確性
- テストの充実度
- セキュリティやパフォーマンスのレビュー
こうした観点でレビューを行う場合、レビュアーに高い技術力が求められます。プログラミング知識はもちろん、ロジックやアルゴリズムに関する深い理解が求められるでしょう。また、セキュリティやパフォーマンスに関する知識は、関連するライブラリやよくある不具合が入り込むポイントを知っているなど、十分な経験が求められます。
教育重視
教育を重視してレビューを行う場合、ジュニアレベルのエンジニアに対して、解説を含んだ丁寧なコメントが求められます。具体的には以下のようなアプローチがあります。
- コードの意図や背景の説明
なぜそのようなコードを書いたのか、意図を説明します - 技術的な解説
使用した技術やライブラリの解説を行います
教育的アプローチでは、レビューイとレビュアー間で多くのコミュニケーションが発生するでしょう。正しいやり方を押しつけるのは簡単ですが、それでもエンジニアの成長を促せません。レビュアーは質問し、それに対してレビューイが答えたり、答えられない場合には最適な解決策を提案したりします。こうしたコミュニケーションを通じて、レビューイの理解を深め、スキル向上を図ります。
文化重視
文化を重視してレビューを行う場合、チームの文化や価値観に配慮した観点が求められます。具体的には以下のようなアプローチがあります。
- トーンや言い回しへの配慮
レビューコメントのトーンや言い回しに注意を払い、建設的なフィードバックを心がけます - チーム文化の形成
チームの価値観や文化を反映したレビューを行います
チームが中長期的に成長していくために、チーム文化の形成と熟成を目的にレビューを行います。このアプローチでは特にレビュー時のトーンや言い回しへの配慮、高い心理的安全性が求められます。レビューを通してコミュニケーションを行い、チーム文化を築き上げていきます。
保守性重視
保守性を重視してレビューを行う場合、コードの可読性や再利用性に焦点を当てます。具体的には以下のようなアプローチがあります。
- コーディングスタイルの統一
チームのコーディングスタイルに従っているかを確認します - ドキュメントの整備
コードの意図や背景がドキュメントに記載されているかを確認します - 再利用性の確認
コードの再利用性を高めるため、重複コードの削減を図ります
チーム開発では、他のメンバーが保守しやすいように、コードの可読性や再利用性を意識したレビューが求められます。クラスや関数を追加する場合には、再利用するためのドキュメントがあるか確認したり、コードの意図が誰でも分かるコメントになっているか確認します。コードレビューを通じてクラスや関数の存在を知れば、他のメンバーも再利用しやすくなります。
まとめ
コードレビューの目的は一つではなく、チームの状況やプロジェクトのフェーズによって異なります。主要な目的として挙げられるのは、品質保証とナレッジ共有、チーム連携・標準化、保守性向上などになります。それぞれに適したレビューアプローチを採用し、チーム開発を効率化しましょう。
それらの目的はチームで共有しましょう。意外とコードレビューの目的が個々人によって異なるチームは多いようです。目的を共有することで、コードレビューの効率が向上し、チーム全体の生産性が高まります。
続きはコードレビューの基本 その2：プルリクエストレビューの基本フロー。
おまけ：CodeRabbitの活用
CodeRabbitはAIコードレビューサービスで、GitHubやGitLabと連携してPRに対して自動的にレビューを実行します。開発者はCodeRabbitからの指摘を確認し、修正を行うことで、コードの品質を向上できます。最近リリースされたCodeRabbit for VSCodeを利用することで、ローカルでのレビューも「無料で」可能になりました。
ぜひ、CodeRabbitを活用して、コードレビューの効率化と品質向上を図ってください。
Discussion