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

組織または個人アカウント用に、既定の issue テンプレートと issue テンプレート用の既定の構成ファイルを作成できます。詳細については、「Creating a default community health file」 (既定のコミュニティ正常性ファイルの作成) を参照してく� さい。

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

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

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

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

false に blank_issues_enabled を設定して、コントリビューターに Issue テンプレートの使用を促すことができます。 blank_issues_enabled を true に設定すると、空の Issue を開くオプションがユーザーに表示されます。

注: 従来のワークフローを使用して.githubフォルダーにissue_template.mdファイルを手動で作成し、config.yml ファイルで空の Issue を有効にした� �合、issue_template.md のテンプレートは空の Issue を開くためにユーザーが選択したときに使用されます。空白の Issue を無効にすると、テンプレートは使用されません。

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

config.yml ファイルの例を次に示します。

YAML

blank_issues_enabled: false
contact_links:
  - name: GitHub Community Support
    url: https://github.com/orgs/community/discussions
    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/ISSUE_TEMPLATE/config.yml と入力します。
新しいファイルの本文に、設定ファイルのコンテンツを入力します。 1. ページの下部で、ファイルに対して行った変更を説明する短く分かりやすいコミットメッセージを入力してく� さい。コミットメッセージでは、複数の作者にコミットを関連づけることができます。詳細については、「複数の共同作成者とのコミットの作成」を参照してく� さい。 1. コミットメッセージフィールドの下で、コミットの追� 先を現在のブランチか新しいブランチから選択してく� さい。現在のブランチがデフォルトブランチなら、コミット用に新しいブランチを作成してからPull Requestを作成すべきです。詳細については、「新しい pull request の作成」を参照してく� さい。 1. [新しいファイルの提案] をクリックします

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

この記事では、次の� �目が扱われます。

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

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

参考資料