はじめに
コードレビューとは、コードの著者以外の人がそのコードを検討するプロセスです。
Googleでは、コードレビューを通じてコードと製品の品質を維持しています。
このドキュメントは、Googleのコードレビューのプロセスとポリシーの正式な説明です。
このページは、コードレビューのプロセスの概要です。このガイドの一部となる他の2つの大きなドキュメントがあります。
- コードレビューの方法: コードリビューアのための詳細なガイドです。
- CL著者ガイド: レビューを受けるCLを作成する開発者のための詳細なガイドです。
コードリビューアは何を見るのか?
コードレビューでは以下の点に注意する必要があります:
- デザイン:コードはシステムに適切に設計されていますか?
- 機能性:コードは作者の意図通りに動作していますか?コードの動作はユーザーにとって良いですか?
- 複雑さ:コードはもっとシンプルにできますか?他の開発者が将来このコードに出くわしたときに簡単に理解して使用できますか?
- テスト:コードには正しい自動テストがありますか?それらは設計が良いですか?
- 命名:開発者は変数、クラス、メソッドなどに明確な名前を選びましたか?
- コメント:コメントは明確で有用ですか?
- スタイル:コードは私たちのスタイルガイドに従っていますか?
- ドキュメンテーション:開発者は関連するドキュメントも更新しましたか?
詳細については、**コードレビューの方法**を参照してください。
最適なリビューアの選択
一般的には、できるだけ早くレビューに対応できる「最適な」リビューアを見つけることが望ましいです。
最適なリビューアとは、あなたが書いているコードの部分に対して、最も詳細かつ正確なレビューをしてくれる人のことです。通常、これはコードの所有者であり、OWNERSファイルに記載されている人々かもしれません。時には、異なる人々に異なる部分のレビューを依頼することもあります。
理想的なリビューアを見つけた場合でも、その人が利用できない場合は、少なくとも変更に関して彼らをCCに追加するべきです。
直接対面でのレビュー(およびペアプログラミング)
もし、コードの一部を資格のある人とペアプログラミングで行い、そのコードに対して良いコードレビューが行われた場合、そのコードはレビュー済みとみなされます。
また、対面でのコードレビューも行うことができます。リビューアが質問をし、変更を行った開発者は問われたときにのみ話すことができます。
関連情報
- コードレビューの方法: コードリビューアのための詳細なガイド。
- CL作成者ガイド: レビューを受けるCLを作成する開発者のための詳細なガイド。