Pull Requestのテンプレートを作って効率よくレビューしよう!

GitHubではプルリクエスト時のテンプレートを作ることができます。 これによって、プルリクエストに書いてほしいことが明らかになるため、レビューする側も効率よくレビューできると思います。 そこで今回は、私が以前に作成したプルリクエストのテンプレートをご紹介します。
2020.03.06

GitHubでは、Pull Requestのテンプレートを作ることができます。

Pull Requestに書いてほしいことが明らかになるため、レビューする側も効率よくレビューできると思います。

  • このPull Requestでやったことはなにか?
  • このPull Requestでやらないことはなにか?
  • 動作確認は何をしたのか?
  • 特に気になるポイントやちょっとしたモヤはあるか?

個人的に「やらないことを明記」は大事だと考えており、レビューする側が「単に忘れてるだけ? それとも後でやるつもりなの?」で迷うことが無くなるのは大きいです。

ただし、Pull Requestの粒度や内容はチームやプロジェクトの特性によってかなり異なると思います。 そこで今回は、私が以前に作成したPull Requestのテンプレートをご紹介します。

Pull Requestのテンプレートの作り方

.githubフォルダを作成し、その中にPULL_REQUEST_TEMPLATE.mdを作成すればOKです。

$ mkdir .github
$ touch .github/PULL_REQUEST_TEMPLATE.md

作成したPull Requestのテンプレート

PULL_REQUEST_TEMPLATE.md

## チケットへのリンク

* https://example.com

## やったこと

* このプルリクで何をしたのか?

## やらないこと

* このプルリクでやらないことは何か?(あれば。無いなら「無し」でOK)

## できるようになること(ユーザ目線)

* 何ができるようになるのか?(あれば。無いなら「無し」でOK)

## できなくなること(ユーザ目線)

* 何ができなくなるのか?(あれば。無いなら「無し」でOK)

## 動作確認

* どのような動作確認を行ったのか? 結果はどうか?

## その他

* レビュワーへの参考情報(実装上の懸念点や注意点などあれば記載)

上記を書くことによるメリット

レビューする側の効率も良くなりますが、それ以上にレビューされる側のメリットが多いと考えています。例えば下記です。

  • ユーザー目線の変更点を書く過程で、動作確認の不足に気づく可能性がある
  • やらないことを書く過程で、「そういえばあの変更もいるな……」と気づく可能性がある

記入例

作業内容によって合う合わない項目もあるため、全項目を埋める必要はありません。

さいごに

各チームに合わせたカスタマイズをしてお使いください。この内容は定期的に見直すと良いですね。