プル リクエストのコードをレビューする

コード レビューは、プル リクエストのプロセスや、開発プロセス全体で不可欠な要素であり、組織やチームに次のようなメリットをもたらします。

• 知識の共有—すべてのコードが有識者によって確認されるため、すべての開発者が新しい領域に取り組んだり、フィードバックを受け取ったりする機会を活用できます。

• 品質保証—経験豊富な開発者であっても、常に学習が必要です。コードを他のユーザーに確認してもらうことで、品質が最高レベルであり、エラーがないことを保証できます。

• 指導の機会 — コードベースに参加したばかりの新しいユーザーは、習熟したメンバーからのフィードバックでさまざまなことを学べます。

プル リクエストでのコードのレビューには、変更の確認と元のコードとの比較を行うことに加えて、コメントやフィードバックを追加してコードのディスカッションを開始する、2 つの要素があります。プル リクエストのレビューの詳細については、「プル リクエストとコード レビュー」の「レビュアー」を参照してください。

アクティビティ フィードにアクセスする

アクティビティ フィードはプル リクエストの [概要] タブにあります。アクティビティ フィードでは、レビューを開始してコメントの追加、返信、解決、いいねができます。また、タスクや Jira 課題を作成することもできます (Jira が Bitbucket ワークスペースに統合されている場合)。アクティビティ フィードを [すべてのアクティビティ]、[マイ コメント]、[すべてのコメント]、[タスク]、[コミット]、または [ステータス] でフィルタリングすることもできます。コードでのコラボレーションとプル リクエストへのフィードバックの詳細をご覧ください。

ファイルの差分を表示する

[変更されたファイル] タブでは、ページの左側にファイル ツリーが表示され、ここから特定の差分に直接アクセスできます。

[変更されたファイル] のフィルターとオプション

• ファイル変更ビューをフィルタリングして、すべての変更 (前回の確認以降の変更のみ) を表示したり、特定のコミットまたは複数のコミットを [コミット] 一覧から選択したりできます。

• [コメント] ドロップダウンから、未解決または解決済みの特定のコメントを見つけて選択できます。このドロップダウンでコメントのリストを展開したり折りたたんだりできます。

• ファイル ツリーにリストされているファイルまたは最近のコメントで差分をソートできます。

既定のプル リクエスト (グローバル差分ビュー) を設定する

1. プル リクエストにアクセスします。

2. [変更されたファイル] タブを選択します。

3. プル リクエストの右上隅にある [設定] ボタン を選択します。

4. プル リクエストのグローバル ビュー設定を更新します。

5. [保存] を選択します。

プル リクエスト設定

• 差分表示 - 既定の差分を統合して表示するか、横に並べるか選択します。

• Show (表示) - 以下のさまざまなオプションを選択して、プル リクエスト内に表示します

  • Whitespace changes (空白の変更) - スペースやタブに関連する変更がファイルに加えられた場合は、その変更をデフォルトで差分表示できます。

  • Word diff (単語の差分) - 更新または変更された行に暗い色の影を付けて表示できます。

  • Color accessibility (色のアクセシビリティ) - 色覚特性をお持ちのユーザー向けに、差分の背景色をよりわかりやすい色に変更できます。 

  • Annotations (アノテーション) - プル リクエストにデフォルトでアノテーションを表示できるようにします。

• ファイルを読み込む

  • All at once (一括) - デフォルトでプル リクエスト内のすべてのファイルを表示できるようにします。

  • Individually (個別) - サイズにかかわらず、プル リクエストにファイルを既定で個別表示できます。

• Tab size (タブ サイズ) - ドロップダウンからタブのデフォルト サイズを選択します。

• File view (ファイル ビュー) - プル リクエストの右側のサイドバーにファイルを表示するデフォルトの方法を選択します。

  • Tree (ツリー) - ファイルを階層形式で表示します。

  • List (リスト) - ファイルを一覧表示します。

各ファイルの表示設定を選択する

ファイルごとに次の表示設定を選択できます。対象ファイル (差分) の上部右端にある [その他のオプション...] (ミートボール) ボタンをクリックして、[その他のオプション...] ドロップダウン メニューから設定を選択します。 

コードでコラボレーションしてフィードバックを提供する

コメントの追加と表示

コメントの追加やディスカッションは、コード レビューのプロセスで大きな割合を占めます。作成者やレビューアがコメントを追加したりディスカッションに返信した後、作成者はプル リクエストの承認を完了するために追加のコミットをプッシュする場合があります。

リポジトリに対して読み取りアクセス権以上を持つすべてのユーザーが、プル リクエストでコメントを追加できます。プル リクエストには以下の 3 段階のコメント レベルがあります。

• プル リクエスト全体

• 個別ファイル

• コードの個別行

プル リクエストにコメントを追加する

プル リクエストに複数のコメントやタスクを追加するには

プル リクエストにコメントやタスクを追加する場合でも、差分に直接追加する場合でも、コメントとタスクをバッチ処理して、メール通知を 1 通だけ受け取れます。

1. コメントの追加やタスクの作成を行います。

2. [レビューを開始] ボタンを選択します。

3. プル リクエストを引き続きレビューし、その他のコメントやタスクをレビューに含めたい場合は、[コメントを追加] を選択します。

4. コメントとタスクをすべて追加したら、[レビューを終了] を選択してレビューを送信します。

   1. レビューの送信前に、[View all pending comments and tasks（保留中のコメントとタスクをすべて表示）] を選択することで、コメントを確認できます。これによって、コメントやタスクのプレビューが開きます。

   2. 承認ステータス：レビューの一環として、レビューを送信する前に、提示された承認ステータスのいずれかを選択する必要があります。

各レベルでコメントを追加するには次の操作を実行します。

• プル リクエスト – プル リクエストの [コメント] で、"コメントを追加" テキスト フィールド内をクリックします。コメントを追加して、[今すぐコメントを追加] を選択します。

• インライン - コメントしたい差分の行に対応する [+] をクリックするか、[今すぐコメントを追加] を選択してタスクを追加します。テキスト フィールドにコメントを追加して、[保存] をクリックします。差分のヘッダーの右側にある [コメントを追加] ボタンを選択して、差分全体にコメントを追加することもできます。

コメントのフォーマット方法

「WYSIWYG」エディターのツールバーを使用します。

他ユーザーへのメンション方法

@ 記号を入力して対象のユーザー名を入力 / 選択することで他のユーザーにメンションできます。

コメントでのアクションの実行

コメントの下部に表示されるリンクを使用して次のようなオプションを利用できます。

• 返信 - 新しいコメント フィールドを開いてやり取りを続行します。

• 解決 - コメント スレッドを解決します。チームと共にこれを使用することで、プル リクエストを承認またはマージする前に、すべてのコメントを確実に処理できるようになります。解決済みのコメント スレッドは、既定では差分に折りたたまれます。

• 編集 - コメント フィールドを再オープンします。更新を行い、再び [コメント] をクリックします。自分のコメントのみ編集できます。

• 削除 - プル リクエストからコメントを完全に削除します。コメントを削除すると、そのコメントはアクティビティからも削除されます。

• いいね! - コメントにいいね! を付けます。

• タスクを作成 - 自分またはプル リクエストのレビュアー向けのタスクを作成します。

• 再オープン - 解決策を見つけるためにさらにアクションが必要な場合に備えて、コメント スレッドをいつでも再オープンできます。古いコメントをオープンする必要がある場合は、差分に関連付けられている古いコメントに移動してコメントを再オープンする必要があります。

プル リクエストのコメントを表示、アクセスする

プル リクエストへのコメントや、ファイルや特定のコード行のインライン コメントはいつでも表示できますが、[コメント] ドロップダウン リストや、[概要] タブの [アクティビティ] でプル リクエストに対して実行された他のアクションのインライン コメントから、コメントを表示したりコメントにアクセスしたりすることもできます。

[コメント] ドロップダウン

差分ヘッダーの上にある [コメント] ドロップダウンを使用して、その差分に関連する解決済み、未解決、または古いコメントに移動できます。

1. [コメント] ドロップダウンを選択します。差分に関する未解決のコメントの数がドロップダウンに表示されます。

2. 差分内の特定のコメントに移動するには、ドロップダウン リストからコメントを選択します。

リストは未解決のコメントと解決済みのコメントに分かれており、未解決のコメントが最初に表示されます。古いコメントは、コメント リスト内で常にそのように表示されます。

タスクを作成する

要求された変更を追跡するために、コメントに 1 つまたは複数のコメントを追加できます。コメント作成者に限らず、「読み取り」権限以上の権限を持つすべてのユーザーがコメントからタスクを作成できます。タスクを作成することで、プル リクエストの作成者に、コード更新の一環として完了する必要がある作業の一覧を提供することができます。 

タスクの作成手順は次のとおりです。

コメント レベルで: コメントに含まれるテキストをタスクにそのまま使用する場合、そのテキストを強調表示して、[タスクを作成] をクリックします。それ以外の場合は、コメントの下の [タスクの作成] をクリックし、タスクの説明を入力して [保存] をクリックします。コメントはコンテキストと連動しているため、右側のサイドバーの [タスク] リストにあるタスクと関連付けられるリンク アイコンをクリックすると、プル リクエストでコメントが強調表示されます。

プル リクエスト レベルで: 右側サイドバーの [タスク] カードの最下部にある [タスクを作成] をクリックします。タスクをテキスト フィールドに入力または追加します。[Enter (Return)] キーを押して、タスクを保存します。

プル リクエストでのタスク一覧の確認方法

タスクは右側サイドバーの [タスク] パネルに一覧表示されます。[概要] タブのアクティビティ フィードにあるコンテキストにもタスクが一覧表示されます。

ファイルを閲覧済みとしてマーク

プル リクエストのレビュアーは、diff (ファイル) ヘッダーの [閲覧済み] チェックボックスを選択して、レビューしたファイルに「閲覧済み」のマークを付けることができます。ファイルに「閲覧済み」のマークを付けると、そのファイルは折りたたまれ、プル リクエストに戻っても、折りたたまれた状態のままになります。

プル リクエストの承認

「読み取り」権限以上の権限を持つすべてのユーザーがプル リクエストを承認できます。

プル リクエストを承認するには、次の手順に従います。

承認するプル リクエスト内で、プル リクエストの右上にある [承認] ボタンを選択します。

コミットにアクセスする

コミットに直接アクセスするには、[コミット] タブを選択し、表示されたリストからコミットを選択します。[コミット] タブからコミットを同期することもできます。