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

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

ご自分のエンタープライズで、リポジトリのメインページへ移動します。 1. リポジトリ名の下にある [設定] をクリックします。 [セキュリティ] タブが表示されない場合は、 [] ドロップダウンメニューを選び、 [設定] をクリックします。
[Features] セクションの [Issue] の下で、 [Set up templates] をクリックします。場合によっては、"issue" を有効にし、ページを更新しないとボタンが表示されません。
[Add template] ドロップダウンメニューで、作成するテンプレートの種類をクリックします。

5. テンプレートをリポジトリにコミットする前にプレビューまたは編集するには、 [Preview and edit] をクリックします。 6. テンプレートを編集するには、をクリックして、フィールドに入力してコンテンツを編集します。 7. 既定の issue タイトルを自動設定するには、リポジトリに読み取りアクセスできるユーザーに issue を割り当てるか、テンプレートから作られた issue にラベルを適用するか、[任意の追加情報] の下にあるフィールドを使いします。これらの詳細は、Issue テンプレートで YAML frontmatter 形式の title、labels、または assignees で追加することもできます。 8. テンプレートの編集とプレビューが終了したら、ページ右上隅にある [変更の提案] をクリックします。 9. 変更内容を説明するコミットメッセージを入力します。 Issue テンプレートの [commit message] フィールド 10. コミットメッセージフィールドの下で、テンプレートを直接デフォルトブランチにコミットするか、新しいブランチを作成してプルリクエストを開くか判断します。 pull request について詳しくは、「pull requests について」をご覧ください。 Issue テンプレートの main へのコミットか pull request を開くかの選択肢 11. [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 AE 外で特定のレポートを受信する場合は、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 テンプレートを作成する

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

参考資料