はじめに
今回はGitHubのプルリクエスト(PR)の一連の流れやコマンドについてやったので、わかりやすいようにまとめていきたいと思います。
プルリクエストとは
自分の変更したコードをリポジトリに取り込んでもらえるよう依頼する機能のこと。
- 機能追加や改修など、作業内容をレビュー・マージ担当者やその他関係者に通知します。
- ソースコードの変更箇所をわかりやすく表示します。
- ソースコードに関するコミュニケーションの場を提供します。
などを目的にしていて、結果として開発者が品質の高いコードを書くことに繋がっています。
プルリクエストの手順
- mainブランチから作業ブランチを切る
- ファイルを変更（実装などの作業をする）
- ファイルの変更をコミットする
- GitHubにpushをする
- プルリクエストを作る
- レビュー依頼をする
- 修正がある場合は修正をする
- approveをもらったらマージする
- ブランチを切り替える
- ローカルのmain(master)ブランチをリモートの最新と一致させる
- 1.で切った作業ブランチを削除する
一連の流れはこんな感じになります。
次からはこちらの手順をコマンドと一緒に見ていこうと思います。
1.mainブランチから作業ブランチを切る
$ git checkout -b <ブランチ名>
-bオプションがついているので切ったブランチを新規作成して、作成したブランチに移動する。
$ git branch <ブランチ名>
$ git checkout <ブランチ名>
これでも同じ動作になりますが上の方が一回のコマンドでできるので便利！！
2.ファイルを変更（実装などの作業をする）
こちらは実際に自分が実装したいファイルなどを変更してください。
3.ファイルの変更をコミットする
ステージに追加する
$ git add <ファイル名>
# 変更したファイルが多い場合
$ git add .
ファイル名のところに「.」を指定すると変更した全てのファイルをステージにまとめて追加することが出来る。
ローカルリポジトリにコミットする
$ git commit
# コミットメッセージも一緒に作成する場合
$ git commit -m "コミットメッセージ"
-mオプションを指定することによってコミットメッセージも一緒に作ることができる。
コミットメッセージは誰が見てもわかりやすように心掛けることと過去形ではなく現在進行形で書くと良い。
例） index.htmlファイルを新規作成
また、コミットはこまめに行う方が良い。
4.GitHubにpushをする
$ git push origin <ブランチ名>
5.プルリクエストを送る
① GitHub→リポジトリ名→Compare&Pull requestを選択する
② 統合するブランチ(写真赤枠部分)と統合元ブランチ(写真青枠部分)のブランチ名を選択する
③ Create Pull requestをする
6.レビュー依頼をする
① Reviewersのところにレビューして欲しい人を追加する
② Assigneesのところで自分を選択する
7.修正がある場合は修正をする
修正箇所があるファイルの修正をする
修正した後はまた変更をコミットする
8.approveをもらったらマージする
① レビューしてくれる方が画像のようにApproveをしてくれます
② Merge pull requestを押してマージする
9.ブランチをmain(master)に変更する
git checkout main
10.ローカルのmain(master)ブランチをリモートの最新と一致させる
$ git pull origin main --rebase
コマンドを打ってローカルのmain（master)ブランチを最新にする
11.1.で切った作業ブランチを削除する
$ git branch -d <ブランチ名>
コマンドを打ってローカルで切った作業ブランチを削除しておく
一連の流れをコマンドだけでまとめてみる
# ブランチを作成
$ git checkout -b <ブランチ名>
# ファイルを変更して変更したファイルをコミットする
$ git add .
$ git commit -m "コミットメッセージ"
# GitHubにPushする
$ git push origin <ブランチ名>
# GitHub上でプルリクエストを送ってマージする
# ブランチをmainに変更する
$ git checkout main
# ローカルのmain(master)ブランチをリモートの最新に更新する
$ git pull origin main --rebase
# 1.で切った作業用ブランチを削除する
$ git branch -d <ブランチ名>
こんな感じでわからない時にすぐに見直せるように記載してみました。
最後に
今回はプルリクエストについてまとめていきました。
私自身まだプルリクエストに慣れていないので、操作する時に何度も見直してやることが多いので１日でも早くこちらの基本的なコマンドには慣れていきたいと思います。
最後までありがとうございました。
それではまた！！
参考文献
https://www.udemy.com/course/unscared_git/
https://www.youtube.com/watch?v=WMIiPcgGC4Q&t=745s
https://www.youtube.com/watch?v=ALQvBsWQ2dA
https://backlog.com/ja/git-tutorial/pull-request/01/