GitHubにIssueとPull Requestのテンプレート機能がつきました。（"Issue and Pull Request templates" - GitHub）とても便利な機能なので、みなさんも使ってみてください。
※本記事は公式の日本語ドキュメントが作成される前に作成され、メンテナンスされていません。ぜひ公式ドキュメントの方をご覧ください。
▼
「公式ドキュメント：テンプレートを使用して便利な Issue やプルリクエストを推進する」
---- 以下いつか消します -----
ファイル配置場所
リポジトリ直下、もしくは.githubフォルダーへ特定の名前がついたファイルを配置することで、Issueを作成するときや、プルリクエストを行うときの説明テキストのテキストエリアに、自動でテキストが挿入されます。
-
ISSUE_TEMPLATE.md- Issueを作成するときのテンプレート -
PULL_REQUEST_TEMPLATE.md- PullRequestを作成するときのテンプレート
また、CONTRIBUTINGと名前のついたファイルを配置すると、Pull Request時のガイドラインとして示すことができます。
-
CONTRIBUTING.md- Pull Request時のガイドライン
※拡張子はなんでも良いようです。
▲GitHubのリポジトリにファイルを配置した例
ISSUE_TEMPLATEを作る
-
ISSUE_TEMPLATE.mdファイルを配置すると、Issue作成時にの説明記入エリアにテキストが挿入される。
複数のIssueテンプレートファイルを作る
Issueに関しては、複数のテンプレートファイルも作れます。例えばバグレポートや機能のリクエストなどはテンプレートが別あると便利です。.github/ISSUE_TEMPLATE フォルダを作成し、中にファイルを追加するだけです。
▼ フォルダを自分で作らなくても、プロジェクトの[Settings]の[Option]、[Features]の[Set up template]ボタンからでも追加できます。
▼ Issueテンプレートを複数作ったときのIssue画面
PULL_REQUEST_TEMPLATE、CONTRIBUTINGを作る
-
PULL_REQUEST_TEMPLATE.mdファイルを配置すると、プルリクエストの説明記入エリアに自動でテキストが挿入される。 -
CONTRIBUTING.mdファイルを配置すると「Please review the guidelines for contributing to this repository.」と文字が表示される。guidelines for contributingの部分のリンクは、CONTRIBUTING.mdへのリンクとなっている。
まとめ
IssueやPull Requestに記入して欲しい情報はある程度決まっていると思います。今回のテンプレート機能を使うことで、記入者はなにを書けばいいのかわかりやすくなり、閲覧者側にとっては見やすいIssueやPull Requestを作成できるようになると思います。