Ruby on Rails プログラミング

プルリクエストを作成する方法

チーム開発で機能ごとにトピックブランチを作り、最終的にマスターブランチに合体(マージ)させるのですが
その前に、コードは誰かに見てもらう必要があります。

そこでプルリクエストという手法を用いて、コードレビューを以来する方法をご紹介します。

プルリクエストとは

ブランチで作業してコミットをしますが、その履歴を残すと共に、
各コミットにおける変更修正にコメントをつけることができる
GitHub の機能のことを言います。

1つのブランチでの作業について、コミュニケーションが取れる掲示板のようなものがプルリクエストです。

*必ず一つはコミットしないと、プルリクエストはできません。

プルリクエストの作成

コミット、プッシュすると、Create Pull Requestというボタンが出てきますので
ここをクリックします。

ブラウザが自動的に立ち上がり、下記の画面に移動します。

ここでは3つの項目を記入します。

  1. プルリクエストのタイトル
    どのような実装なのか、完結に書きます。[WIP]というのはwork in progressの略で、
    現在実装中という事です。完了している実装の場合は記載しなくてOKです。
  2. 詳細
    ここには、どのような実装をしたのかを、#What, #Whyに従って記入します。
    どのような実装を、なぜ行うのかを明確にする事で、レビューする時に見やすくなります。
  3. 最後にCreat Pull requestをクリックしてプルリクエストを作成します。

コードレビューを依頼する

次に、先ほど作成したプルリクエストをチームベンバーなど、他の方に送って
コードレビューしてもらう必要があります。

Create Pull requestをクリックした後、以下のような画面になっているかと思います。
この画面のURLをレビューしてもらいたい人に送りましょう。

pull/1というURLになっている事がわかると思います。
これがpull request用のURLです。

マージしよう

上記プルリクエストでレビューしてもらってOKがでたら、
masterブランチへマージして実装内容を反映させましょう。

Merge pull requestをクリックしてマージしましょう。

次にconfirm mergeをクリックします。

すると、以下のようにPull requestは無事マージされましたと出ますので、Delete branchをクリックしてブランチを削除しましょう。

プルしよう

上記でpull requestをマージした事で、リモートリポジトリでは master ブランチにマージすることができました。
次にローカルリポジトリにマージした情報を反映する必要があります。

リモートリポジトリの変更をローカルリポジトリに取り込む操作のことをプルと言います。

まず、Github desktopにて、ブランチをmasterに切り替えます。
masterをクリックしてください。

次に、Fetch originをクリックして、リモートとの差分を確認します。

Fetch originがPull originに変わるので、クリックして完了です。

これでローカルリポジトリも作業ブランチ(トピックブランチ)をマージした状態が反映されました

まとめ

ブランチを用いた開発の流れについて一通り解説しました。
慣れるまで大変かと思いますが、1人で作業する際も積極的に上記の流れに沿って作業を行い
実際のチーム開発で慌てる事が無いようにしたいですね!

 

-Ruby on Rails, プログラミング

© 2021 yuyalife Powered by STINGER