どうも、とがみんです。
チーム開発をする際に、コードレビューをしているでしょうか?
この記事では、コードレビューに関する、プルリクエストの作成方法と、レビュー方法について紹介していきます。
プルリクエストとは？
「プルリクエスト」とは、開発者のローカルリポジトリで加えた変更を、他の開発者に知らせ、レビューしてもらう機能です。
レビューしてもらう事によって、一人では気づく事の出来なかったコードの記述ミスやバグに気づく事ができ、
コードの品質を高める事ができます。
レビューした人は、そのコードに問題なければ、margeし、本流のブランチにコードを組み込んだりします。
プルリクエストの作成方法
プルリクエストのやり方について説明していきます。
作業手順については、前回の続きから説明していきます。
一旦、招待された側で、ブランチを作成します。
招待された側で、ブランチをgitTest2とし、Create Branchを押します。
その後、Pushボタンを押し、リモートリポジトリに反映させます。
Githubを確認すると新しいブランチができている事が確認できます。
また、以下のように、SourceTree上でも、リモートにgitTest2ブランチができたことが確認できます。
次に、gitTest2ブランチにチェックアウトしている状態で、gitTest.htmlファイルを以下のように追加します。
1 2 3 4 5 6 7 | <!--省略--> <body> <p>Git勉強用</p> <p>ブランチの勉強</p> <p>プルリクエスト</p><!--追加--> </body> <!--省略--> |
その後、ステージング、commitします。
そして、以下のように、pushボタンを押し、gitTest2ブランチのみを選択します。
push後、SourceTreeのHistoryを確認すると、リモートリポジトリのgitTest2ブランチにのみ、変更が反映されている事がわかります。
次に、gitTest2に反映させた変更をmasterブランチにmargeする前に、このリポジトリのオーナーに「プルリクエスト」を送ります。
GitHubに移動し、以下のNew pull requestを選択し、プルリクエストを作成します。
以下のように、gitTest2を選択し、gitTest2の内容をmasterにmargeするリクエストを作成します。
リクエストする際のコメントを記述し、変更箇所を確認したら、Create pull requestボタンを押します。これで、プルリクエストが完了します。
プルリクエストのレビュー方法
次に、プルリクエストを受けとった側のレビューの仕方について説明していきます。
GitHubのリポジトリに移動し、Pull requestのタブを選択後、レビューをするリクエストを選択します。
その後、File Changeタブを選択し、変更を確認します。
変更箇所を確認後、Review changesボタンを押し、リクエストに対するコメントをします。
Commentは、軽微な指摘やちょっとしたコメントの場合に使用し、
Approveはこれで問題ない！という場合に使用します。
また、Request changesは修正依頼で、これがついた場合は、リポジトリオーナーか、管理者しか、margeできなくなります。
レビューが終了したら、Marge pull request ボタンを選択し、margeします。これで、リモートのgitTest2ブランチの内容が、リモートのmasterブランチに反映されます。
まとめ
プルリクエストの作成方法や、プルリクエストのレビューの方法について紹介しました。
何か不明点等あれば、ご指摘いただけると嬉しいです。
