[GitHub] IssueとPull Requestのテンプレート機能を利用してフォーマットを統一する

IssueとPull Requestのテンプレートを作成しておけば、Issue・Pull Requestを作成するタミングでテンプレートの内容をデフォルトで表示してくれる機能があります。
Issue・Pull Requestを作成する人が複数人いる場合は、フォーマットが人に依存したり、フォーマットの指定があっても守ってくれない人がいるケースもあると思いますが、GitHubのテンプレ機能を利用することで、作業者が複数人でも統一したフォーマットをあらかじめ用意しておくことができます。

RailsのリポジトリでもGitHubのテンプレート機能は使われています。

この記事は個人ブログでも掲載しています。
http://tackeyy.com/blog/how-to-make-github-issue-and-pull_request-template

テンプレートの配置場所

以下のどちらかにテンプレートファイルを配置してください。

• リポジトリのルートディレクトリ
• .github/ ディレクトリ直下

Railsは .github/ 以下にファイルを置いているのでぼくもそれにあわせてみました。

テンプレートファイル

マークダウンに対応しているので以下の名前で *.md ファイルを作成します。

• PULL_REQUEST_TEMPLATE.md
• ISSUE_TEMPLATE.md

以下のような感じでファイルを置いてください。
GitHubの説明上はファイル名は大文字なのですが、小文字にしても問題ありません。

.github/issue_template.md

+### Summary
+
+### TODO

.github/pull_request_template.md

+fixes #
+
+### Summary
+
+### Other Information

どんな感じになるか？

（昔のbranchからmasterに向けたPull Requestなのでコンフリクトしてます）

参考