ドキュメントには頻繁に更新が加えられ、その都度公開されています。本ページの翻訳はまだ未完成な部分があることをご了承ください。最新の情報については、英語のドキュメンテーションをご参照ください。本ページの翻訳に問題がある場合はこちらまでご連絡ください。

Issueとプルリクエストのテンプレートについて

Issue及びプルリクエストのテンプレートを使えば、コントリビューターがリポジトリでIssuleやプルリクエストをオープンする際に含めてほしい情報をカスタマイズし、標準化できます。

リポジトリでIssueやプルリクエストのテンプレートを作成すると、コントリビューターはそのテンプレートを使い、リポジトリのコントリビューションのガイドラインに沿ってIssuelをオープンしたり、プルリクエスト中の変更を提案したりできるようになります。 リポジトリへのコントリビューションのガイドラインの追加に関する詳しい情報についてはリポジトリのコントリビューターへのガイドラインの設定を参照してください。

自分の Organization 用にデフォルトの Issue およびプルリクエストのテンプレートを作成できます。 詳細は「Organization 用にデフォルトのコミュニティ健全性ファイルを作成する」を参照してください。

Issueのテンプレート

Issueテンプレートビルダーを使ってリポジトリにIssueのテンプレートを作成すると、それらはコントリビューターがリポジトリで新しいIssueをオープンする際に使えるようになります。

Issue テンプレートの選択肢が表示された新規 Issue ページ

テンプレートビルダーを使うと、各テンプレートに対してタイトルと説明を指定し、テンプレートの内容を追加し、リポジトリ中でそのテンプレートをデフォルトブランチにコミットするか、プルリクエストをオープンできます。 テンプレートビルダーは、新しい Issue ページにテンプレートを表示するのに必要となる YAML front matter マークアップを自動的に追加してくれます。 For more information, see "Configuring issue templates for your repository."

Issue テンプレートは、リポジトリのデフォルトブランチ中の隠しディレクトリ .github/ISSUE_TEMPLATE に保存されます。 テンプレートを他のブランチで作成した場合、それをコラボレーターが使うことはできません。 Issue テンプレートのファイル名では大文字と小文字は区別されません。拡張子は .md でなければなりません。 コミュニティプロフィールチェックリストに含まれるためには、Issue テンプレートは .github/ISSUE_TEMPLATE フォルダ内になければならず、適切な name: および about:YAML front matter を含まなければなりません。

レガシーの Issue テンプレートワークフローを使い、手作業で単一の Issue テンプレートを Markdown で作成することもできます。その場合、プロジェクトのコントリビューターは自動的に Issue の本文にテンプレートの内容を見ることになります。 とはいえ、Issue テンプレートの作成にはアップグレードされた複数 Issue テンプレートビルダーを使うことをおすすめします。 レガシーのワークフローに関する詳しい情報については、「リポジトリ用の単一 Issue テンプレートを手動で作成する」を参照してください。

プルリクエストのテンプレート

リポジトリにプルリクエストのテンプレートを追加すると、プロジェクトのコントリビューターはプルリクエストの本体にテンプレートの内容を自動的に見ることになります。

サンプルのプルリクエストテンプレート

テンプレートは、リポジトリのデフォルトブランチに作成しなければなりません。 他のブランチに作成されたテンプレートは、コラボレーターが使用できません。 プルリクエストのテンプレートは、リポジトリの見えるルートディレクトリ、docs フォルダ、または隠しディレクトリ .github に保存できます。 プルリクエストテンプレートのファイル名は大文字と小文字が区別されません。拡張子としては .md または .txt を使用できます。

詳細は「リポジトリのプルリクエストテンプレートを作成する」を参照してください。

担当者にお尋ねください

探しているものが見つからなかったでしょうか?

弊社にお問い合わせください