プルリクエストの使用方法

プルリクエストとは

プルリクエストとは、ある開発ブランチの変更をほかの開発者のブランチに取り込んでもらうためのリクエストを出す機能のことです。

Backlogのプルリクエストでは、以下のようなことができます。

  • 機能追加や改修などの内容を、レビュー・マージ担当者やその他関係者に通知する
  • ソースの変更箇所をわかりやすく表示する
  • コードについて意見等をコメントする

詳しくは以下を参照してください。

サルでもわかるGit入門 プルリクエスト編

プルリクエストの一覧

プルリクエストの一覧画面では、登録済みのプルリクエストの一覧を表示することができます。

状態ごとに表示を切りかえる

最初に画面を開くと、状態が「Open」のプルリクエストだけが一覧に表示されています。

状態が「Close」や「Merged」のプルリクエストを表示したい場合は、テーブルヘッダの「状態」をクリックしフィルタを変更してください。

プルリクエストを検索する

プルリクエストの一覧を絞り込んで表示したい場合は「キーワード」にキーワードを入力してください。

プルリクエストの追加

プルリクエストを追加するには、Git の ブランチ 画面、ブランチ / タグ間差分 の画面、もしくは プルリクエストの一覧 画面から進みます。

プルリクエストの追加 | プロジェクト管理ツールBacklog

プルリクエストを追加する

以下の手順でプルリクエストを追加してください。

  1. 「ブランチ」で、ターゲットブランチ(プルリクエストをマージする対象のブランチ)とプルリクエストブランチ(マージしてもらうブランチ)を選択します
  2. ターゲットブランチとプルリクエストブランチを選択したタイミングで、「コミット履歴」と「ファイル」の差分が閲覧できます
  3. プルリクエストブランチの名前に、Backlogの課題キーを含めておくと、その課題の件名が「件名」に表示されます
  4. 「関連課題」にその課題キーが自動で設定されます。これらの値は変更することもできます
  5. 「担当者」には、プルリクエストのレビューやマージを依頼するユーザを選択します
  6. プルリクエストを追加したユーザと担当者が異なる場合は自動で担当者にお知らせが届きます

プルリクエストのマージ後にブランチを削除する

プルリクエストを追加するときに「マージ後にブランチを削除する」にチェック✅をいれておけば、マージされた後にブランチを削除します。

プルリクエストの追加 | プロジェクト管理ツールBacklog

プルリクエストの編集

プルリクエストの一覧画面で任意のプルリクエストを選択して詳細画面に進み、「編集」をクリックすると、プルリクエストを編集できます。

ターゲットブランチ(プルリクエストをマージする対象のブランチ)とプルリクエストブランチ(マージしてもらうブランチ)は変更することはできません。

プルリクエストの編集 | プロジェクト管理ツールBacklog

プルリクエストのコメント

プルリクエストのコメントは課題のコメントのように、お知らせしたいユーザを指定してコメントできます。

プルリクエストの登録時や更新時、コメント登録時に送信されるメールに返信してもプルリクエストにコメントは登録できません。

また、コードを指定してコメントもできます。「ファイル」タブでコードを表示し、マウスオーバーした時に対象の行に表示されるプラスボタンをクリックするとコメント欄が表示されます。

修正してほしい内容とお知らせしたいユーザーを入力し登録をクリックします。

プルリクエストのクローズ

プルリクエストされたコードをマージせずにクローズする場合はプルリクエストの詳細画面で「却下」ボタンをクリックします。

プルリクエストのクローズ | プロジェクト管理ツールBacklog

プルリクエストのマージ

プルリクエストされたコードをマージする場合はプルリクエストの詳細画面で「マージ」ボタンをクリックします。

マージ後に作業ブランチを削除する

マージボタンをクリックする前に「マージ後に作業ブランチを削除する」にチェック✅を入れておけば、マージした後に作業ブランチが削除されます。

競合が発生している場合

コードが競合する場合はメッセージが表示され、Backlog上からはマージできません。この場合はツールやコマンドプロンプト等で競合を解消しマージしてください。

もしくは、競合を解消したあとのコードをプッシュしてから、Backlog上から「マージ」ボタンをクリックしてください。