GitHub

GitHubのIssuesおよびPull Requestsにテンプレートを登録することができるようになりました

More than 1 year has passed since last update.

GitHubを使っていて今まで不便だった点として、「IssueやPull Requestの投稿内容を規定することができなかった」ことがあると思います。最初の投稿内容がどうしても不十分なものになってしまい、詳細を聞き出すことから毎回始めなければならない、といった苦痛をいつも感じていた人は多いはずです。

この苦痛も過去のものとなりそうです。IssueやPull Requestにテンプレートが作れるようになりました。Issue and Pull Request templatesという題名で新規機能のアナウンスがありましたので、さっそく日本語に訳してみました。参考になると幸いです。


IssuesおよびPull Requestsのテンプレート

重要な詳細が欠けている問題を解決することは困難です。今、プロジェクトの管理者は、プロジェクトのIssuesやPull Requestsのためにテンプレートを追加することができるようになりました。これらは、スレッドを開始する際に貢献者が正しい詳細を追加することを助けてくれます。これは、私たちがコミュニティからのフィードバックに基づいて行っているIssuesやPull Requestsに対する多くの改良の中で最初のものです。

リポジトリにIssueテンプレートを追加するために、ルートディレクトリ内にISSUE_TEMPLATEという名前のファイルを作成してください。ファイルの拡張子は任意ですが、Markdownファイル(.md)がサポートされます。Markdownサポートは、見出し、リンク、@記号による言及、そしてタスクリストをあなたのテンプレートに追加することを簡単にします。

Pull Requestテンプレートも同じパターンに従います: あなたのリポジトリのルートディレクトリに、PULL_REQUEST_TEMPLATEという名前のファイルを追加してください。

もしかしたら、あなたのプロジェクトのルートディレクトリがファイルの追加によって散らってしまうことが気になることもあると思いますので、私たちは.github/フォルダのサポートも追加しました。あなたは、CONTRIBUTING.mdISSUE_TEMPLATE.md, そしてPULL_REQUEST_TEMPLATE.mdファイルを.github/内に配置することができますし、それらは全て期待通りに機能するでしょう。

この機能の追加情報は、このドキュメントをチェックしてください