コードレビューは、ソフトウェア品質を向上させるためには不可欠です。しかし、コードレビューに多くの工数が割かれ、開発スピードが遅くなってしまうと言う課題もよく聞かれます。そして、それらの課題が割と典型的なものが多く、どの開発チームでも同様の課題を抱えています。
本記事では、コードレビューを効率化するための6つの具体的な手法を紹介します。これらの手法を取り入れることで、コードレビューの工数を減らし、開発スピードを向上させられるはずです。
手法1：レビュー対象の範囲を適切に絞る
プルリクエストを送る側は、小さなプルリクエストを意識しましょう。一つのタスクが巨大すぎる場合、サブタスクに分けて、それぞれにプルリクエストを送ると良いでしょう。変更範囲が広すぎると、レビューに時間がかかります。また、見落としや不具合の混入が起こりやすくなります。目安として「1つのPRは300行以内」が理想です。それ以上長くなると全体を把握するのに工数がかかってしまい、レビューの質が低下します。
WIP（Work in Progress）プルリクエストを活用することも効果的です。途中段階のコードをチームに共有し、早期フィードバックを得ることで、早い段階で問題を洗い出せるでしょう。早期に問題を解消することで、後のレビュー工数を減らせる効果が期待できます。
手法2：静的解析ツールを活用して指摘の自動化を進める
プログラミング言語には、静的解析ツール（Lintツール）が数多くあります。そうしたツールは、コードのフォーマットやスタイルなど、良くある問題を自動的に指摘してくれます。毎度同じ指摘を行うのはレビュアーとしてストレスがかかるので、自動チェックツールの活用は非常に有効です。
なお、静的解析ツールの利用時には、あまりルールを厳しくしないのがお勧めです。特にプロジェクトの途中から導入すると、指摘事項に合わせた修正だけで大きな工数を取られてしまいます。導入時にはゆるく、チームの開発スタイルに合わせて徐々にルールを追加していくのがお勧めです。
こうした静的解析ツールはCI/CDと組み合わせて利用したり、ローカルのIDEに組み込んで利用したりできます。ローカルの時点で指摘を解消しておくことで、CI/CDパイプラインでもエラーなく運用できるでしょう。
手法3：コードレビューのガイドラインを策定する
コードレビューガイドラインに明記することは、以下の通りです。
- 目的
- 基本方針
- チェックポイント
- ワークフロー
目的
コードレビューを何の目的で行うのかを明記します。多くの場合、コードレビューはプロダクトの品質向上、チームメンバーのスキル向上、コードの一貫性を保つために行われるでしょう。
この内容によって、レビュアーが指摘すべきこと、チェックすべきことが変わってきます。
基本方針
コードレビューの基本方針を明記します。例えば、レビュアーは「感情的なコメントをしない」、「指摘は具体的で建設的なものにする」などのルールを設けることで、コードレビューの品質を向上させることができます。
チェックポイント
レビュアーが見るべきポイントを明確し、レビュアーごとのレビュー品質の差を軽減します。人によって指摘事項が異なると、レビューを受ける側（レビューイー）が混乱します。その結果、レビューを受けているのにプロダクトの品質が安定しないという状態になるでしょう。
チェックポイントが公開されることで、レビューイーも、どの部分に注意を払うべきかが明確になります。
ワークフロー
CI/CDに組み込まれている場合、ブランチやタイトルなどで自動処理が行われる場合があります。そうした自動処理との連携を考慮して、コードレビューのワークフローを明記します。
また、レビュアーがどういったタイトルや説明を付けるべきかも明記しておきましょう。レビューイーはどのタイミング（毎日なのか、週一なのかなど）でコードレビューを行うかも明記しておくと、スムーズにコードレビューを進めることができるでしょう。
レビューはなるべく早い方が良いのは確かです。しかし、多くの場合レビューアーはシニアクラスで忙しく、レビューに時間を割けない場合も多々あります。そのため、レビューの優先順位を明確にしておくことも重要です。
手法4：レビューコメントのテンプレートを用意する
レビューコメントの書き方には、個人差があります。そのため、レビューコメントの質がばらついてしまうのは致し方ないのですが、その内容によって受け取り側の対応のしやすさが大きく変わります。
そこで、レビューコメントのテンプレートを用意し、レビューの効率化を図りましょう。以下は、おすすめのコメントテンプレートです。
- 質問の場合
この処理はどのような意図がありますか？ - 提案の場合
この処理はmapを使うともっとシンプルに書けます - 指摘の場合
このコードではnullの考慮が抜けています
なお、こうしたコメントテンプレートを用意することで、コメントを感情的にせず、建設的なフィードバックが可能になります。この時のコツとしては、「NO（これはダメ）」ではなく、「こうすれば良くなります」というトーンが大事になります。
手法5：ペアプログラミングやモブレビューを活用する
コードを実際に書いている段階でフィードバックをもらえれば、その後のコードレビューの負荷を減らせます。この時に使えるのが「ペアプログラミング」と「モブレビュー」です。
この二つの方法は、「後から指摘する」のではなく「最初から良いコードを書く」意識をチームに植え付けます。
ペアプログラミング
ペアプログラミングとは、二人のプログラマーが組んでコーディングを行う取り組みです。特にジュニアレベルのプログラマーとシニアが組むことで、実開発を行いながらコードレビューと同等のフィードバックを行えます。
モブレビュー
モブレビューとは、開発の初期段階やプロトタイプのレベルでチーム全員に対して説明し、フィードバックを得る取り組みです。これによって、チーム全員がベストプラクティスの共有を進め、ビジネスドメインの知識を共有できるといったメリットがあります。
手法6：AIレビューの活用
最後にAIベースのコードレビューサービスの活用です。前述の静的解析ツールと似ていますが、AIベースの場合はより深いインサイトが得られます。シニアエンジニアのような指摘をしてくれたり、コードの品質を評価してくれたりします。
私たちの提供するCodeRabbitは、AIを活用したコードレビューサービスです。AIがコードを読み込み、コードの品質を評価し、改善点を指摘してくれます。これによって、コードレビューの工数を大幅に削減し、開発スピードを向上させることができます。
まとめ
今回は、コードレビューを効率化するための6つの手法を紹介しました。これらの手法を取り入れることで、コードレビューの工数を減らし、チーム全体の開発スピードを向上させられるはずです。ぜひ、試してください。
Discussion