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

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

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

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

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

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

ファイルの差分の確認

各プル リクエストには、リポジトリへの変更とマージ先のリポジトリまたはブランチを比較するために、各ファイルの差分が表示されます。 

デフォルトのプル リクエストを設定する

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

  2. プル リクエストの右上にある [Pull request settings (プル リクエスト設定)] ボタン (アイコン) をクリックします。

  3. プル リクエスト設定を更新します。

  4. 保存をクリックします。

プル リクエスト設定

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

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

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

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

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

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

  • ファイルを読み込む

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

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

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

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

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

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

新しいプル リクエスト設定で、[Pull request settings (プル リクエスト設定)] に [ファイルを個々に読み込み] 設定を追加しました。有効化すると、表示するすべてのプル リクエストで、プル リクエストの大きさにかかわらず、ファイルが個別に表示されます。無効化すると、8,000 行以上のプル リクエストでのみ、ファイルが個別に表示されます。これは、読み込みプロセスを最適化し、ファイルを適切に読み込み、表示できるようにするためです。

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

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

ラベル

説明

横に並べて表示

コードの変更を 2 列で表示します。左側の列 (前バージョン) には元のコードが、右側の列 (新バージョン) には更新内容が表示されます。

ファイル全体を表示

別のモーダルでファイル全体を開き、ファイル全体を表示して、くまなくコメントできます。

ソースで開く

ファイルを [ソース] ビューで開きます。引き続き、Bitbucket で完全なファイルを表示して編集を行うことができます。

コメントを追加

プル リクエストでファイルにコメントを追加します。プル リクエストにコメントを追加する他の方法については、「コメントの追加」を参照してください。

すべてのファイルを折りたたむ

差分ビューですべてのファイルを折りたたみます。

すべてのファイルを展開

差分ビューですべてのファイルを展開します。

プル リクエストの新しい機能をオプト インしていない場合、上記の設定は [概要] タブの [変更されたファイル] にあります。既定の表示設定は、変更がまとめて一列に表示される統合された差分です。


コードのディスカッションとフィードバック

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

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

  • プル リクエスト全体

  • 個別ファイル

  • コードの個別行

インライン コメントが表示できない場合

コメントがユーザーによって削除されている場合を除き、コメントは引き続き存在しています。行のコンテンツが削除されると、コメントを利用できなくなります。この場合、ファイル差分画面の上部にある数字のボタンを探します。このボタンをクリックすると、前のバージョンのすべてのコメントが表示されます。

コメントを追加する

リポジトリへの書き込みアクセス権を持つすべてのユーザーが、プル リクエストでコメントを追加できます。 

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

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

  • ファイル - ファイルの上部右端にある [その他のオプション ] ボタン > [コメントを追加] の順にクリックします。テキスト フィールドにコメントを追加して、[保存] をクリックします。

  • インライン - コメントを残すコードの行 (またはタブ) にマウス ポインターをスクロール > 行番号とコード行の間に表示される [+] アイコンをクリックします。テキスト フィールドにコメントを追加し、[保存] をクリックします。

プル リクエストの新しい機能をオプトインしていない場合、以下の方法でプル リクエストにコメントを残すことができます。

  • プル リクエスト—[概要] タブの [コメント] で、"What do you want to sat?" と表示されているテキスト フィールドをクリックします。

  • ファイル—ファイル差分の上部にある [コメント] ボタンをクリックします。

  • インライン - 行の横にある、[この行にコメントを追加] ボタンをクリックします。


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

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

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

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

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

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

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

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

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

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

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

プル リクエストでのコメントの表示とコメントへのアクセス

コメントは、ファイルまたは特定のコード行を使って、プル リクエストまたはインラインに常時表示できます。また、右側のサイドバーの [アクティビティ] でプル リクエストに対して他のアクションを実行することで、コメントをインラインに表示することもできます。

  • コメントに関連付けられているリンクをクリックすると、差分ファイルのコメントに移動します。 

  • アクティビティ フィードで、[マイ コメント] および [すべてのコメント] を使用してフィルタリングできます。

  • 古いコメントは新しいモーダルで開きます。

タスクの作成

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

リポジトリ管理者は、プル リクエストのマージ前にすべてのタスクを完了させるようにする、マージ チェックリスト項目を設定できます。

レビューアが実行できる操作

作成者とリポジトリ管理者が実行できる操作

  • タスクの作成

  • 既存のタスクの解決

  • 自身のタスクの編集

  • 自身のタスクの削除

  • 任意のタスクの編集

  • 任意のタスクの削除

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

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

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

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

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

プル リクエストの新しい機能をオプトインしていない場合、以下の方法でプル リクエストでタスクを作成、表示できます。

  • プル リクエスト—[概要] タブの [コメント] で、"What do you want to sat?" と表示されているテキスト フィールドをクリックします。

  • ファイル—ファイル差分の上部にある [コメント] ボタンをクリックします。

  • インライン - 行の横にある、[この行にコメントを追加] ボタンをクリックします。

プル リクエストでタスクを表示する

右側のメタデータ セクションでタスクのリンクを検索します。例: 2 つのオープン タスクまたはすべての解決したタスク。見つかったリンクをクリックして、すべてのオープンおよび解決したタスクを確認します。このオプションが表示されるのは、プル リクエストに複数のタスクがある場合のみです。

最終更新日 2021年02月23日)
次でキャッシュ 1:38 AM on Oct 16, 2021 |

その他のヘルプ