このバージョンの GitHub Enterprise サーバーはこの日付をもって終了となりました: 2024-09-25. 重大なセキュリティの問題に対してであっても、パッチリリースは作成されません。 パフォーマンスの向上、セキュリティの向上、新機能の向上を図るために、最新バージョンの GitHub Enterprise サーバーにアップグレードしてください。 アップグレードに関するヘルプについては、GitHub Enterprise サポートにお問い合わせください。

リポジトリ用の単一 Issue テンプレートを手動で作成する

手動で作成した Issue テンプレートをリポジトリに追加すると、プロジェクトのコントリビューターは自動的に Issue の本体でテンプレートの内容が見えるようになります。

この記事の内容

これは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
---

注: Front matter 値に、: などの YAML 予約文字が含まれている場合は、値全体を引用符で囲む必要があります。 たとえば、":bug: Bug" または ":new: triage needed, :bug: bug" です。

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

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

  1. GitHub で、リポジトリのメイン ページに移動します。

  2. ファイルの一覧の上にある、 [ファイルの追加] ドロップダウンを使用し、 [新しいファイルの作成] をクリックします。

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

    • 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 の作成」を参照してください。

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

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

  5. [コミット メッセージ] フィールドに、ファイルに対する変更内容を説明する、短くわかりやすいコミット メッセージを入力します。 コミットメッセージでは、複数の作者にコミットを関連づけることができます。 詳しくは、「複数の作者を持つコミットを作成する」を参照してください。

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

    GitHub pull request のスクリーンショット。メイン ブランチに直接コミットする、または新しいブランチを作成するためのラジオ ボタンが表示されています。 新しいブランチが選ばれています。
    コラボレーターがテンプレートを利用できるのは、テンプレートがリポジトリのデフォルトのブランチにマージされる場合です。

  7. [変更のコミット] または [変更の提案] をクリックします。

参考資料