リポジトリ用に Issue テンプレートを設定する

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

Issue テンプレートを作成する

1. GitHub Enterprise Serverで、リポジトリのメインページにアクセスしてください。
2. リポジトリ名の下で Settings（設定）をクリックしてください。
3. [Features] セクションの [Issues] の下で、[Set up templates] をクリックします。
4. [Add template] ドロップダウンメニューで、作成するテンプレートの種類をクリックします。
5. テンプレートをリポジトリにコミットする前にプレビューまたは編集するには、[Preview and edit] をクリックします。
6. テンプレートを編集するには、 をクリックし、フィールドに入力してコンテンツを編集します。
7. デフォルトの Issue タイトルを自動的に設定するには、リポジトリへの読み取りアクセスを持つ人に Issue を割り当てるか、ラベルを Issue テンプレートに適用し、こうした詳細な情報を [Optional additional information] の下に入力します。 このような詳細情報を Issue テンプレートに、title、labels、または assignees を YAML frontmatter フォーマットで使用して、追加することもできます。
8. テンプレートの編集とプレビューが終了したら、ページ右上隅にある [Propose changes] をクリックします。
9. 変更内容を説明するコミットメッセージを入力します。
10. コミットメッセージフィールドの下で、テンプレートを直接デフォルトブランチにコミットするか、新しいブランチを作成してプルリクエストを開くか判断します。 プルリクエストに関する詳しい情報については「プルリクエストについて」を参照してください。
11. [Commit changes] をクリックしてください。 変更がデフォルトブランチにマージされると、コントリビューターがリポジトリで新しい Issue を開くときにテンプレートを使用できるようになります。

テンプレート選択画面を設定する

リポジトリで新しいIssueを作成する時に表示されるIssueテンプレートの選択画面は、.github/ISSUE_TEMPLATEフォルダーにconfig.ymlファイルを追加することによってカスタマイズできます。

blank_issues_enabled を false に設定すると、コントリビューターに Issue テンプレートの使用を促すことができます。 blank_issues_enabled を true に設定すると、空白の Issue を開くこともできます。

GitHub Enterprise Server外で特定のレポートを受信する場合は、contact_links を使用して外部サイトにユーザを誘導できます。

config.yml ファイルの例は次のとおりです。

blank_issues_enabled: false
contact_links:
  - name: GitHub Community Support
    url: https://github.community/
    about: Please ask and answer questions here.
  - name: GitHub Security Bug Bounty
    url: https://bounty.github.com/
    about: Please report security vulnerabilities here.

設定ファイルでは、ファイルがリポジトリのデフォルトブランチにマージされるときにテンプレート選択画面をカスタマイズします。

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

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

3. ファイル名フィールドに .github/ISSUE_TEMPLATE/config.yml と入力します。

4. 新しいファイルの本文に、設定ファイルのコンテンツを入力します。

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

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

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

参考リンク

• Issueとプルリクエストのテンプレートについて
• "リポジトリ用の単一 Issue テンプレートを手動で作成する"