Skip to main content

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

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

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

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

これはIssueテンプレートを作成するためのレガシーのワークフローです。 Issueテンプレートの作成には、アップグレードされた複数IssueテンプレートビルダーあるいはIssue formsを使用することをおすすめします。 詳細については、「Issue と pull request テンプレートについて」を参照してく� さい。

サポートされている任意のフォルダー内に ISSUE_TEMPLATE/ サブディレクトリを作成すると、複数の Issue テンプレートを含めることができます。また、template クエリ パラメーターを使用すると、Issue の本文に使用するテンプレートを指定することができます。 詳細については、クエリ パラメーターを使用した Issue と pull request の自動化に関するページを参照してく� さい。

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 テンプレート用の既定の構成ファイルを作成できます。 詳細については、「Creating a default community health file」 (既定のコミュニティ正常性ファイルの作成) を参照してく� さい。

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

  1. で、リポジトリのメイン ページへ移動します。 1. ファイルの一覧の上にある、 [ファイルの追� ] ドロップダウンを使用し、 [新しいファイルの作成] をクリックします。 [ファイルの追� ] ドロップダウンの [新しいファイルの作成]
  2. ファイル名フィールドで:
    • Issue テンプレートをリポジトリのルート ディレクトリ内に表示するには、issue_template の名前を入力します。 たとえば、issue_template.md のようにします。 ルート ディレクトリの新しい Issue テンプレート名
    • Issue テンプレートをリポジトリの docs ディレクトリ内に表示するには、「docs/ 」、issue_template の名前の� �に入力します。 たとえば、docs/issue_template.mddocs ディレクトリの新しい Issue テンプレートなどです
    • ファイルを� しディレクトリ内に� �納するには、「github/ 」、issue_template の名前の� �に入力します。 たとえば、.github/issue_template.md のようにします。 � しディレクトリの新しい Issue テンプレート
    • 複数の Issue テンプレートを作成したり、template クエリ パラメーターを使用して、Issue 本文に使用するテンプレートを指定したりするには、「 .github/ISSUE_TEMPLATE/ 」、Issue テンプレートの名前の� �に入力します。 たとえば、.github/ISSUE_TEMPLATE/issue_template.md のようにします。 ルートまたは docs/ ディレクトリ内の ISSUE_TEMPLATE サブディレクトリに、複数の Issue テンプレートを� �納することもできます。 詳細については、クエリ パラメーターを使用した Issue と pull request の自動化に関するページを参照してく� さい。 � しディレクトリの複数の新しい Issue テンプレート
  3. 新しいファイルの本文に Issue テンプレートを追� します。 そこに盛り込むべき� �目として、以下のようなものがあります:
    - YAML frontmatter
    - 予測される動作と実際の動作
    - 問題を再現する手� �
    - 仕様 (プロジェクトのバージョン、オペレーティング システ� 、またはハードウェアなど) 1. ページの下部で、ファイルに対して行った変更を説明する短く分かりやすいコミットメッセージを入力してく� さい。 コミットメッセージでは、複数の作者にコミットを関連づけることができます。 詳細については、「[複数の共同作成者とのコミットの作成](/articles/creating-a-commit-with-multiple-authors)」を参照してく� さい。
    
    変更のコミット メッセージ 1. コミットメッセージフィールドの下で、コミットの追� 先を現在のブランチか新しいブランチから選択してく� さい。 現在のブランチがデフォルトブランチなら、コミット用に新しいブランチを作成してからPull Requestを作成すべきです。 詳細については、「新しい pull request の作成」を参照してく� さい。 コミット ブランチのオプション コラボレーターがテンプレートを利用できるのは、テンプレートがリポジトリのデフォルトのブランチにマージされる� �合です。
  4. [新しいファイルの提案] [新しいファイルの提案] ボタンをクリックします

参考資料