😸

Git入門(操作編 - Pullリクエスト)

2023/09/03に公開

Git入門(操作編 - Pullリクエスト)

GitHubのプルリクエストを使ってみる

今回、リモートブランチ(develp)の変更内容をmainブランチにPullリクエストします。
Pullリクエストは作業者が他者にコードをレビューしてもらい、派生元のブランチにマージ依頼する機能です。

レビューイ(レビューを受ける側)の作業

Pullリクエストを送る側(レビュー、マージを依頼する側)の流れを説明します。

  1. WebからGitHubの上の対象リポジトリを開きます。

  2. 「Pull request」タブを選択します。
    Pullリクエスト

  3. 「New pull request」ボタンを押下します。
    Pullリクエスト

  4. Pullリクエスト元のブランチとPullリクエスト先のブランチを選択して、変更点を確認します。
    問題なければ、「Creaste pull request」ボタンを押下します。

    Pull元/先 説明 選択するブランチ
    base ベースとなるブランチ(マージ先のブランチ) 今回はmainブランチを選択します。
    compare Pullリクエストする側のブランチ(マージするブランチ) 今回はdevelopブランチを選択します。

Pullリクエスト

  1. Pullリクエストの依頼(レビュー / マージ)を行うため、メッセージを入力して、「Create pull request」ボタンを押下します。
    Pullリクエスト

これでPullリクエストが送られました。レビューを依頼する側の作業は完了です。

レビューア(レビューを受ける)側のが作業

次の手順でレビューを行います。

  1. WebからGitHubの上の対象リポジトリを開きます。

  2. 「Pull request」タブを選択します。現在のPullリクエストの一覧が表示されるので対象のプルリクエストを選択して下さい。
    Pullリクエスト

  3. 選択したPullリクエストの詳細が表示されるので、「File changed」タブを選択します。
    Pullリクエスト

  4. ファイルの変更点をチェックします。
    Pullリクエスト

  5. GitHubでは「+」ボタンを押下する事で変更点にコメントを入力できます。必要に応じてコメントは追加して下さい。
    Pullリクエスト

    ボタン 説明
    Add single comment コメントを登録する度にPullリクエストの送信者に通知されます。
    Start a review コメントが[pending]になります。
    最後にまとめてPullリクエストの送信者に通知されます。
  6. 最後に「Review changed」ボタンを押下します。
    レビューが問題なければ、「Comment」を選択して「Submit review」ボタンを押下して下さい。
    Pullリクエスト

    オプション 説明
    Commnet 後続に影響のない一般的なフィードバックです。
    特に修正事項もなく承認必須の運用にしていない場合に利用します。
    (通常はこちらになるかと思います。)
    Approve Pullリクエストのが問題ない場合に承認します。
    承認必須の運用にしている場合、承認することで初めてマージできるようになります。
    Request changes 修正依頼を出します。
    Pullリクエストの送信者が送信しないとマージできません。
  7. 「Conversation」タブで「Merge pull request」ボタンを押下します。
    Pullリクエスト

  8. 「Confirm Merge」ボタンを押下します。
    Pullリクエスト

  9. これでマージが完了です。
    ブランチが不要であれば、「Delete branch」ボタンを押下して削除して下さい。
    Pullリクエスト

関連記事

Discussion