知っていると便利なGitHubのプルリクの機能

こんにちは。
PHR事業開発部の村越です。

GitHubのPullRequestには、レビューがしやすくなる機能がいくつもあります。
今回は、そちらをいくつか紹介しようと思います。

1.インラインコメント

Files Changedタブのコード行左の「＋」ボタンから、インラインコメント追加が可能です

コードの特定の箇所への指摘は、Conversationタブでコメントをつけるより、こちらから行に対してコメントを入れたほうがレビューイの方がどこへの指摘なのかわかりやすくなるかと思います。

2.Suggestion

上記のインラインコメント時に、レビュアーが修正案を提示出来る機能です。
インラインコメント時に、「Add a suggestion」を押し、修正後のコードを記載してコメント追加することで出来ます。

提示された修正案は、「Commit Suggestion」から取り込むことが可能です。

3.Approve、Request Change

レビュー時に、レビューイがマージして大丈夫か、マージしては駄目かを表す機能として、「Approve」と「Request Change」があります。
どちらも、Files Changedタブ右上の「Finish your review」から選択可能です。

「Approve」を選択して「Submit review」を押すと、レビュー終わりました。マージして問題ないですよという状態を表すことが出来ます。
「Request Change」を選択すると、指摘した箇所を直さないとマージしては駄目ですよという状態を表すことが出来ます。
また、こちらの状態ですと、「Merge pull request」のボタンがレビュアーが「Approve」を選択しないと押せない状態になるので、レビューの指摘修正が間違っていたのでマージしてしまったなどが防げると思います。

4.Viewed

差分のファイルを確認したかを判別できる機能です。

ファイル名右の「Viewed」のチェックマークを付けることにより、上部の「files viewed」にカウントされ、全体のどれくらいを確認したか、どのファイルを確認し終わったかなどがわかるようになっています。
また、こちらのチェックマークは、該当のファイルに修正が追加された場合、自動でチェックが外れるので、追加の修正があった場合にどのファイルが更新されたかなどが分かりやすくなります。

5.Hide whitespace

差分のうち、スペースやタブの差分を削除して表示してくれる機能です。
歯車マークから、「Hide whitespace」にチェックを入れると有効になります。

スペース関連で差分が多い場合、実際の差分の見逃しに繋がる可能性があるので、チェックを入れておくとレビューの精度が上がるかもしれません。
ただし、インデントがおかしくなっている場合なども差分がでなくなるので、その辺りも確認したい場合は注意が必要です。

最後に

今回はGitHubのプルリクの機能について紹介しました。
ただコメントするだけより、レビュアーがしやすく、レビューイが見やすくなると思っていますので、今回紹介したような便利な機能は適宜活用してレビューを効率よく進められればと思います。

今回は以上となります。
今後とも「PSP」をよろしくお願い致します。

村越