ドキュメントには頻繁に更新が加えられ、その都度公開されています。本ページの翻訳はまだ未完成な部分があることをご了承ください。最新の情報については、英語のドキュメンテーションをご参照ください。本ページの翻訳に問題がある場合はこちらまでご連絡ください。
GitHub AEは、現在限定リリース中です。詳細については営業チームにお問い合わせください。

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

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

これはIssueテンプレートを作成するためのレガシーのワークフローです。 複数のIssue テンプレートの作成にはアップグレードされた複数 Issue テンプレートビルダーを使うことをおすすめします。 詳しい情報については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
---

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

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

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

  2. ファイルのリストの上で、Add file(ファイルの追加)ドロップダウンを使い、Create new file(新規ファイルの作成をクリックしてください。 "ファイルの追加"ドロップダウン内の"新規ファイル作成"

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

    • Issue テンプレートをリポジトリのルートディレクトリで表示するには、issue_template の名前を入力します。 たとえば、issue_template.md です。 ルートディレクトリの新しい Issue テンプレート名
    • リポジトリの docs ディレクトリに Issue テンプレートを表示するには、docs/ に続けて issue_template の名前を入力します。 たとえば、docs/issue_template.md です。 docs ディレクトリの新しい Issue テンプレート
    • ファイルを隠しディレクトリに格納するには、.github/ と入力し、続いて issue_template という名前を入力します。 たとえば、.github/issue_template.md です。 隠しディレクトリの新しい Issue テンプレート
    • 複数 Issue テンプレートを作成し、template クエリパラメータを使用して Issue の本文に使用するテンプレートを指定するには、.github/ISSUE_TEMPLATE/ と入力し、続けて Issue テンプレートの名前を入力します。 たとえば、.github/ISSUE_TEMPLATE/issue_template.md です。 複数 Issue テンプレートをルートディレクトリや docs/ ディレクトリにある ISSUE_TEMPLATE サブディレクトリに格納することもできます。 詳細は「クエリパラメータによる Issue およびプルリクエストの自動化について」を参照してください。 隠しディレクトリの新しい複数 Issue テンプレート
  4. 新しいファイルの本文に Issue テンプレートを追加します。 そこに盛り込むべき項目として、以下のようなものがあります:

    • YAML frontmatter
    • 予測される動作と実際の動作
    • 問題の再現手順
    • プロジェクトのベンダー、オペレーティング システム、ハードウェアなどの仕様
  5. ページの下部で、ファイルに対して行った変更を説明する短く分かりやすいコミットメッセージを入力してください。 コミットメッセージでは、複数の作者にコミットを関連づけることができます。 詳しい情報については「複数の共作者を持つコミットの作成」を参照してください。 変更のコミットメッセージ

  6. コミットメッセージフィールドの下で、コミットを追加を現在のブランチか新しいブランチから選択してください。 現在のブランチがデフォルトブランチなら、コミット用に新しいブランチを作成してからPull Requestを作成すべきです。 詳しい情報については「新しいプルリクエストの作成」を参照してください。 コミットブランチのオプション テンプレートがリポジトリのデフォルトブランチにマージされると、コラボレーターがテンプレートを使用できるようになります。

  7. Propose new file(新規ファイルの提案)をクリックしてください。 新規ファイルの提案ボタン

参考リンク

このドキュメントは役立ちましたか?プライバシーポリシー

これらのドキュメントを素晴らしいものにするのを手伝ってください!

GitHubのすべてのドキュメントはオープンソースです。間違っていたり、はっきりしないところがありましたか?Pull Requestをお送りください。

コントリビューションを行う

OR, コントリビューションの方法を学んでください。

問題がまだ解決していませんか?

GitHubコミュニティで質問するサポートへの連絡