結構前の記事になってしまいますが、Github上でIssue, Pull-RequestのTemplate機能を使うことが可能になりました。
https://github.com/blog/2111-issue-and-pull-request-templates
これを社内で試してみたところ、結構評判が良かったので、テンプレート作成方法を紹介します。
作り方
以下のルールでテンプレートファイルを作成し、それらを指定したパスに置けばテンプレート機能を使うことができます。
テンプレートファイル名
| Template | ファイル名 | できること |
|---|---|---|
| Issue | ISSUE_TEMPLATE.md | Issue作成時のテンプレート |
| Pull-Request | PULL_REQUEST_TEMPLATE.md | Pull-Request作成時のテンプレート |
| Contribute | CONTRIBUTING.md | Issueへのコメント、PullRequest時に guidelines for contributing というリンクが表示される |
テンプレートファイルを置く場所
テンプレートが適用されると
例えばissue作成時に、ISSUE_TEMPLATE.mdの内容が入力された状態で表示されます。
CONTRIBUTING.mdの案内もちゃんと出てますね。
Template機能使用時の注意
これらの機能を反映させるには対象リポジトリのDefault branch上にテンプレートファイルが置かれている必要があります。
Default branchとは、git cloneした際に最初に設定されていたり、Pull-Request時のBase branchとして設定されているブランチのことです。
初期設定ではmasterに設定されているので、masterにテンプレートファイルが置かれればテンプレート機能を使うことができます。
運用上、Default branchが別のブランチに設定されている場合は、そのブランチ上にテンプレートファイルを設置するようにして下さい。