プルリクエストとは
GitHubが提供する機能の一つ。作業者が他者にソースコードのレビュー(確認)と、ブランチへのマージを依頼する機能のことである。
他者にソースコードをレビューしてもらうことにより、品質の改善につながる。
プルリクエストの機能として、
- プルリクエストを作成するとレビュー担当者に通知が行くので、確認漏れを防止できる
- ソースコードの変更箇所を分かりやすく表示する
- レビュー担当者はソースコードの修正してほしいところにコメントを投げることができる
- 上記のコメントは修正が完了するまで残るので、開発担当者は指摘された箇所を忘れず修正することができる
実際にプルリクをやってみよう
あらかじめorigin
に適当なリモートリポジトリを追加しておいてください。リモートリポジトリが空の場合は、ローカルの内容をプッシュしておいてください。
# masterブランチにいることを確認する
$ git branch
* master
# masterブランチを最新の状態にする
$ git pull origin master
remote: Enumerating objects: 4, done.
remote: Counting objects: 100% (4/4), done.
remote: Compressing objects: 100% (2/2), done.
remote: Total 3 (delta 0), reused 0 (delta 0), pack-reused 0
Unpacking objects: 100% (3/3), done.
From https://github.com/Kasumin0123/git_test
* branch master -> FETCH_HEAD
* [new branch] master -> origin/master
Updating 2d5ae52..6c2c72e
Fast-forward
home.html | 1 +
1 file changed, 1 insertion(+)
create mode 100644 home.html
# 新しいブランチを切って、変更を加える
$ git checkout -b pull_request
Switched to a new branch 'pull_request'
$ echo 'pull request' > pull_request.txt
$ git add .
$ git commit -m 'Create pull_request.txt'
[pull_request 23a0d8a] Create pull_request.txt
1 file changed, 1 insertion(+)
create mode 100644 pull_request.txt
# 変更をプッシュする
$ git push origin pull_request
変更をプッシュするところまで終わったら、いよいよプルリクエストを作成していく。
ブラウザからGitHubのリポジトリを開いて、上のタブにあるPull requestsをクリックする。そして、New pull requestボタンをクリックする。そうしたら
上の図のように、baseにmaster
、compareにpull_request
を指定する。baseはマージを行うブランチで、compareはマージしてもらうブランチである。
次に、Create pull requestボタンをクリックする。タイトルには先ほど書いたコミットメッセージ「Create pull_request.txt」と表示されているはずだ。タイトルは書き替えてもよいしそのままでもよい。後は本文に適当なメッセージを入力しておこう。今回はこのようにした。
そうしたら、Create pull requestボタンを押す。これでプルリクエストが作成できた。後は、
画面の右側にあるReviewersをクリックして、レビューをお願いしたい人の名前を入力する。そうすることで、その人に通知が送られる。