2016年2月18日にGitHubのPull RequestとIssuesの投稿にテンプレート機能が追加された。
https://github.com/blog/2111-issue-and-pull-request-templates
今まではPull RequestやIssuesを作る時の投稿内容にはテンプレート機能がなく、人によって内容がマチマチだったり、プロジェクトで記載内容のルールはあるものの形骸化されてしまったり、、なんてことがあった。これによりレビューに必要な情報が不足していてレビューイ、レビュアー間で余計なコミュニケーションコストが発生してしまいレビューがスムーズに進まない、、ということに繋がっていた。
だが、今回のテンプレート機能が追加されたことにより、投稿内容の粒度を揃えレビューに必要な情報をテンプレートに則って全員が漏れなく記述できる、新規参画者がPull Request、Issuesを出す時に迷わなくなるといった恩恵を受けることが可能になり、レビューをスムーズに進められることになると思う。
テンプレートの適用は非常に簡単で、リポジトリのルートディレクトリに「PULL_REQUEST_TEMPLATE」もしくは「PULL_REQUEST_TEMPLATE.md」というファイル名でテンプレートファイルを配置するだけでOK。以下試しにやってみた。
1. リポジトリのルートディレクトリにテンプレートファイルを作成する
リポジトリのトップページでNew Fileボタンをポチる。
ファイル名に「PULL_REQUEST_TEMPLATE.md」もしくは「PULL_REQUEST_TEMPLATE」を入力する。
テンプレートはプロジェクトに合ったものを入力する。ここでは以下のようなテンプレートを作ってみた。ちなみに、テンプレートには@メンションで特定の人を予めつけておいたり、#XXXで特定のプルリクへの参照リンクを予めつけておいたりも出来る。
テンプレートをプレビューするとこんな感じ。
Commit new fileボタンをポチる(テンプレートファイルの作成)。
プルリクを出してテンプレートを確認してみる
適当にブランチを作って確認してみた。ちゃんとテンプレートが効いてるのがわかる。
参考にしたサイト
https://help.github.com/articles/creating-a-pull-request-template-for-your-repository/
※GitHub公式ヘルプ
https://github.com/blog/2111-issue-and-pull-request-templates
※GitHub公式ブログ