リポジトリ用の単一 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
---

Organizationもしくはユーザアカウント用に、デフォルトのIssueテンプレート及びIssueテンプレートのためのデフォルトの設定ファイルを作成できます。 詳しい情報については「デフォルトのコミュニティ健全性ファイルを作成する」を参照してください。

Issue テンプレートを追加する

1. GitHub Enterprise Serverで、リポジトリのメインページにアクセスしてください。

2. ファイルのリストの上のCreate new file（新規ファイルの作成）をクリックしてください。

3. ファイル名フィールドで:

   • Issue テンプレートをリポジトリのルートディレクトリで表示するには、issue_template の名前を入力します。 たとえば、issue_template.md です。
   • リポジトリの docs ディレクトリに Issue テンプレートを表示するには、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 です。 複数 Issue テンプレートをルートディレクトリや docs/ ディレクトリにある ISSUE_TEMPLATE サブディレクトリに格納することもできます。 詳細は「クエリパラメータによる Issue およびプルリクエストの自動化について」を参照してください。

4. 新しいファイルの本文に Issue テンプレートを追加します。 そこに盛り込むべき項目として、以下のようなものがあります:

   • YAML frontmatter
   • 予測される動作と実際の動作
   • 問題の再現手順
   • プロジェクトのベンダー、オペレーティング システム、ハードウェアなどの仕様

5. ページの下部で、ファイルに対して行った変更を説明する短く分かりやすいコミットメッセージを入力してください。 コミットメッセージでは、複数の作者にコミットを関連づけることができます。 詳しい情報については「複数の共作者を持つコミットの作成」を参照してください。

6. コミットメッセージフィールドの下で、コミットを追加を現在のブランチか新しいブランチから選択してください。 現在のブランチがデフォルトブランチなら、コミット用に新しいブランチを作成してからPull Requestを作成すべきです。 詳しい情報については「新しいプルリクエストの作成」を参照してください。 テンプレートがリポジトリのデフォルトブランチにマージされると、コラボレーターがテンプレートを使用できるようになります。

7. Propose new file（新規ファイルの提案）をクリックしてください。

参考リンク

• Issueとプルリクエストのテンプレートについて
• リポジトリ用に Issue テンプレートを設定する
• 「クエリパラメータによる Issue およびプルリクエストの自動化について」
• Issue の作成