今朝方Twitterを覗いていたら、rebuild.fmでお馴染みの宮川達彦さんが以下のツイートをされていました。
:+1: @github https://t.co/nQBukVNNTK
— Tatsuhiko Miyagawa (@miyagawa) 2016, 2月 17
なんと!GithubにIssueとPull Requestのテンプレート機能が実装されただと!
面白そうな機能が来たので眠気が完全に覚め、今記事を書こうという次第でございます。
どんな機能なの?
そもそもどんな機能なのかというと、リポジトリのルートディレクトリまたは.github
ディレクトリ内に、Issueの場合はISSUE_TEMPLATE
、Pull Requestの場合はPULL_REQUEST_TEMPLATE
を作成することで各々その内容に沿ったテンプレートが表示されるようです。
まぁとりあえずはやってみましょう。
Issueのテンプレート
とりあえず手始めにIssueの方から。
テンプレートにはMarkdown fileがサポートされていると書いてあるので、ISSUE_TEMPLATE.md
というファイルを作成します。
(拡張子は何でも良いと書いてあるので、単純にISSUE_TEMPLATE
という名前のファイルでも良いです)
# 見出し この文章は__ISSUE_TEMPLATE.md__によって作成されています。
これをリポジトリにコミットして、Issueを作成してみましょう。
おー!出来てますね!
Pull Requestのテンプレート
次はPull Requestのテンプレートをやってみましょう。
# 見出し この文章はPULL_REQUEST_TEMPLATE.md__によって作成されています。
これで、Pull Requestを作成してみると・・・
こちらも出来てますね!
まとめ
このテンプレート機能によって、今までIssueやPull Requestの内容は作成者に委ねられていたのをコントロールすることが出来るようになりました。 使い方は人それぞれになるだろうとは思いますが、IssueやPull Requestに製作者の感謝の気持ちを載せるのも素敵かもしれませんね。