Pull request を作成したら、変更を確認してフィードバックを提供するようにチームに依頼します。 このガイドでは、レビューが容易でチームに常に情報を提供できる pull request を作成するためのベスト プラクティスについて説明します。これにより、コラボレーションとレビューの質を高めることができます。
変更を簡単に確認できるようにする
Pull request 内のコンテキストを明確にすると、変更した内容とそれが重要な理由をレビュー担当者がすぐに把握できます。 その結果、レビュー プロセスが迅速かつスムーズになり、やり取りの回数が減り、チームがより良いフィードバックを提供し、自信を持って判断を下せるようになります。 Pull request の作成の詳細については、「pull request の作成」を参照してください。
小さい PR を書き込む
1 つの目的を満たす、焦点を絞った小さな pull request を作成することを目的とします。 pull request を小さくすると、レビューとマージが簡単かつ迅速になり、バグを導入する余地が少なくなり、変更の履歴がより明確になります。
最初に独自の pull request を確認する
送信する前に、独自の pull request を確認、ビルド、テストします。 これにより、他のユーザーがレビューを開始する前に、見逃した可能性のあるエラーや入力ミスをキャッチできます。
コンテキストとガイダンスを提供する
pull request の内容をレビュー担当者がすぐに理解できるように、pull request の明確なタイトルと説明を記述します。 pull request の本文は次のようになります。
- pull request の目的
- 変更点の概要
- 問題の追跡や以前の会話など、追加のコンテキストへのリンク
レビュー担当者を支援するには、必要なフィードバックの種類を共有します。 たとえば、ざっと見るだけでよいでしょうか、それとも深い批評が必要でしょうか。
pull request が複数のファイルに対する変更で構成されている場合は、ファイルをレビューする順序に関するガイダンスをレビュー担当者に提供します。 開始する場所とレビューを続行する方法を勧めます。
チームに常に情報を提供する
Pull request は、コードの変更を文書化するだけでなく、自分の作業状況をチームやマネージャーに常に知らせることができる強力な方法でもあります。 Pull request で進行状況を視覚化することで、個別に更新する必要性を減らし、全員が足並みを揃えることができます。
関連する issue やプロジェクトへのリンク
Pull request を関連する issue やプロジェクト ボードに接続して、自分の作業がより大きなプロジェクトの中でどのような位置付けになるかを確認します。
- 説明に
Closes ISSUE-LINKのようなキーワードを追加すると、pull request のマージ時に issue が自動的にリンクされ、終了されます。 - Projects を使って作業を追跡し、pull request からプロジェクトにリンクすると、進行状況を 1 か所で簡単に追跡できます。 「Projects について」を参照してください。
状態をラベルで強調表示する
レビューの準備ができている、ブロックされている、または進行中であることを示す状態ラベルを pull request に追加します。 こうすることで、レビュー担当者は作業の状態を一目で理解できるようになります。 詳しくは、「ラベルを管理する」をご覧ください。