Warning
これはIssueテンプレートを作成するためのレガシーのワークフローです。 Issueテンプレートの作成には、アップグレードされた複数IssueテンプレートビルダーあるいはIssue formsを使用することをおすすめします。 詳しくは、「Issueとプルリクエストのテンプレートについて」を参照してください。
サポートされている任意のフォルダー内に ISSUE_TEMPLATE/ サブディレクトリを作成すると、複数の Issue テンプレートを含めることができます。また、template クエリ パラメーターを使用すると、Issue の本文に使用するテンプレートを指定することができます。 詳しくは、「Issue の作成」をご覧ください。
YAML frontmatter を各 Issue テンプレートに追加して、Issue のタイトルを事前に入力したり、ラベルおよびアサインされた人を自動追加したり、リポジトリに新しい Issue を作成するときに表示されるテンプレート選択画面に表示されるテンプレートの名前と説明を指定したりすることができます。
YAML front matter の例は次のとおりです。
---
name: Tracking issue
about: Use this template for tracking new features.
title: "[DATE]: [FEATURE NAME]"
labels: tracking issue, needs triage
assignees: octocat
---
Note
Front matter 値に、: などの YAML 予約文字が含まれている場合は、値全体を引用符で囲む必要があります。 たとえば、":bug: Bug" または ":new: triage needed, :bug: bug" です。
組織または個人アカウント用に、既定の issue テンプレートと issue テンプレート用の既定の構成ファイルを作成できます。 詳しくは、「既定のコミュニティ正常性ファイルの作成」を参照してください。
Issue テンプレートを追加する
-
GitHub で、リポジトリのメイン ページに移動します。
-
ファイル リストの上にある [Add file ] ドロップダウン メニューを選んで、[ Create new file] をクリックします。
または、左側のファイル ツリー ビューの をクリックしてもかまいません。
![リポジトリのメイン ページのスクリーンショット。 ファイルの一覧の上には、[ファイルの追加] というラベルが付いたボタンが濃いオレンジ色の枠線で囲まれています。 リポジトリのファイル ツリー ビューでは、+ アイコンが付いたボタンも濃いオレンジ色で囲まれています。](/assets/cb-60263/images/help/repository/add-file-buttons.png)
-
ファイル名フィールドで:
- Issue テンプレートをリポジトリのルート ディレクトリ内に表示するには、issue_template の名前を入力します。 たとえば、
issue_template.mdのようにします。 - Issue テンプレートをリポジトリの
docsディレクトリ内に表示するには、「docs/ 」、issue_template の名前の順に入力します。 たとえば、docs/issue_template.mdのようにします。 - ファイルを隠しディレクトリ内に格納するには、「github/ 」、issue_template の名前の順に入力します。 たとえば、
.github/issue_template.mdのようにします。 - 複数の Issue テンプレートを作成したり、
templateクエリ パラメーターを使用して、Issue 本文に使用するテンプレートを指定したりするには、「 .github/ISSUE_TEMPLATE/ 」、Issue テンプレートの名前の順に入力します。 たとえば、.github/ISSUE_TEMPLATE/issue_template.mdのようにします。 ルートまたはdocs/ディレクトリ内のISSUE_TEMPLATEサブディレクトリに、複数の Issue テンプレートを格納することもできます。 詳しくは、「Issue の作成」をご覧ください。
- Issue テンプレートをリポジトリのルート ディレクトリ内に表示するには、issue_template の名前を入力します。 たとえば、
-
新しいファイルの本文に Issue テンプレートを追加します。 そこに盛り込むべき項目として、以下のようなものがあります:
- YAML frontmatter
- 予測される動作と実際の動作
- 問題を再現する手順
- 仕様 (プロジェクトのバージョン、オペレーティング システム、またはハードウェアなど)
-
[変更のコミット...] をクリックします。
-
[コミット メッセージ] フィールドに、ファイルに対する変更内容を説明する、短くわかりやすいコミット メッセージを入力します。 コミットメッセージでは、複数の作者にコミットを関連づけることができます。 詳しくは、「複数の作者を持つコミットを作成する」を参照してください。
-
コミットメッセージフィールドの下で、コミットの追加先を現在のブランチか新しいブランチから選択してください。 現在のブランチがデフォルトブランチなら、コミット用に新しいブランチを作成してからPull Requestを作成すべきです。 詳しくは、「pull request の作成」を参照してください。
コラボレーターがテンプレートを利用できるのは、テンプレートがリポジトリのデフォルトのブランチにマージされる場合です。
-
[変更のコミット] または [変更の提案] をクリックします。
![リポジトリのメイン ページのスクリーンショット。 ファイルの一覧の上には、[ファイルの追加] というラベルが付いたボタンが濃いオレンジ色の枠線で囲まれています。 リポジトリのファイル ツリー ビューでは、+ アイコンが付いたボタンも濃いオレンジ色で囲まれています。](/assets/cb-60263/mw-1440/images/help/repository/add-file-buttons.webp)
