読者です 読者をやめる 読者になる 読者になる

Tbpgr Blog

Ruby プログラマ tbpgr(てぃーびー) のブログ

GitHubに新規追加された神機能Issue Template/Pull Request Template機能でホクホクしつつ「あの方法」と比較する

f:id:tbpg:20160219021348p:plain

2016/02/18 GitHubにIssue and Pull Request templates機能が追加されました。

github.com

ISSUE_TEMPLATE , PULL_REQUEST_TEMPLATE という名前でプロジェクトのrootにテンプレートを配置しておくだけで オーケーです。お手軽。 (拡張子は自由。 Markdown 形式 = .md に対応)

早速ISSUE_TEMPLATEをコミットして動作確認してみました。

サンプル

ISSUE_TEMPLATE

  • テンプレート
## 概要

## 詳細

あれこれ

:paw_prints:
  • GitHub に push したテンプレート

f:id:tbpg:20160219021359p:plain

Issue

f:id:tbpg:20160219021348p:plain

黒魔術テンプレート

この機能が実装されるまでの間、下記のようにURLのパラメータに直接テンプレートを設定し、
CLIに仕込んだり、情報共有ツールWikiにリンクを作成してテンプレートとして使っていた方が
少なからずいると思います。
仮にこのやり方を「黒魔術テンプレート」とします。

qiita.com

qiita.com

tbpgr.hatenablog.com

pros and cons

今までの黒魔術テンプレートと比較してみます。視点はGitHubの新機能側にしています。

pros

  • テンプレート自体をGitHubで履歴管理できる

cons

  • タイトルのテンプレートは設定できない
  • ラベルの指定はできない

まとめ

新機能のIssue and Pull Request templatesですが、
今まで黒魔術テンプレートを利用していなかった人にとっては とても便利です。

しかし、黒魔術テンプレートを利用していた人にとってはタイトルを指定できなくなったり、
ラベルに合わせた複数テンプレートが指定できないなどの問題があります。

複数のテンプレートを必要としないなら迷いなく今回のテンプレートを使えばいいですし、
複数のテンプレートを利用する場合も、ひとまずデフォルトに一番使用頻度の高いテンプレートを設定しておく
という判断がよさそうですね。

この辺り今後の進化に期待ですね。