ドキュメントには頻繁に更新が加えられ、その都度公開されています。本ページの翻訳はまだ未完成な部分があることをご了承ください。最新の情報については、英語のドキュメンテーションをご参照ください。本ページの翻訳に問題がある場合はこちらまでご連絡ください。
記事のバージョン: GitHub.com

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

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

これはIssueのテンプレートを作成するための古いワークフローです。アップグレードされた複数のIssueテンプレートビルダーを使って複数のIssueテンプレートを作成することをおすすめします。詳しい情報についてはIssue及びプルリクエストテンプレートを参照してください。

サポートしているどのフォルダーにでも ISSUE_TEMPLATE/ サブディレクトリを作成し、Issue テンプレートを複数含めることができます。また、template クエリパラメータで Issue の本文に使用するテンプレートを指定できます。 詳細は「クエリパラメータによる Issue およびプルリクエストの自動化について」を参照してください。

コミュニティプロフィールチェックリストに含まれるためには、Issue テンプレートは .github/ISSUE_TEMPLATE フォルダ内になければならず、適切な name: および about:YAML front matter を含まなければなりません。

Organization に対してデフォルトの Issue テンプレートを作成できます。詳細は「Organization のデフォルトのコミュニティ健全性ファイルを作成する」を参照してください。

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

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

  2. ファイルリストの上にある [Create new file(新しいファイルを作成)] をクリックします。

    新しいファイル ボタン

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

    • Issue テンプレートをリポジトリのルートディレクトリで表示するには、issue_template の名前を入力します。 たとえば、issue_template.md です。
      ルートディレクトリの新しい Issue テンプレート名
    • Issue テンプレートをリポジトリの docs ディレクトリで表示するには、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 テンプレートを追加します。 そこに盛り込むべき項目として、以下のようなものがあります:

    • 予測される動作と実際の動作
    • 問題の再現手順
    • プロジェクトのベンダー、オペレーティング システム、ハードウェアなどの仕様。
  5. オプションで、デフォルトの Issue タイトルを自動的に設定する、または Issue テンプレートにアサインされた人にラベルを追加するには、 titlelabelsassignees を使用して、Issue テンプレートに YAML frontmatter を追加します。 `


title: 'Bug report' labels: bug assignees: octocat


  <div class="extended-markdown note border rounded-1 mb-4 p-3 border-blue bg-blue-light f5">

  **メモ:** YAML で予約済みの文字の場合は、その文字を引用符で囲む必要があります。 たとえば、`:bug: Bug` のようにラベル名に絵文字を追加する場合は、`":bug: Bug"` のように引用符で囲みます。`:` が予約済みの文字だからです。

  </div>
1. ページの下部で、ファイルに行った変更について述べた短く意味のあるコミットメッセージを入力してください。コミットメッセージ内でコミットを複数の作者に関連付けることができます。詳細は「[複数の共同作者を持つコミットを作成する](/articles/creating-a-commit-with-multiple-authors)」を参照してください。
![変更のコミットメッセージ](/assets/images/help/repository/write-commit-message-quick-pull.png)

1. コミットメッセージフィールドの下で、コミットを現在のブランチに追加するか、新しいブランチを作成するかを判断してください。現在のブランチが `master` なら、コミットに新しいブランチを作成することにして、[プルリクエストを作成](/articles/creating-a-pull-request)してください。
![Commit branch options](/assets/images/help/repository/choose-commit-branch.png)
 テンプレートがリポジトリのデフォルトブランチにマージされると、コラボレーターがテンプレートを使用できるようになります。
1. [**Propose new file(新しいファイルを提案)**] をクリックしてください。
![Propose new file ボタン](/assets/images/help/repository/new-file-commit-button.png)

### 参考リンク

- [Issueとプルリクエストのテンプレートについて](/articles/about-issue-and-pull-request-templates)
- [リポジトリ用に Issue テンプレートを作成する](/articles/creating-issue-templates-for-your-repository)
- 「[クエリパラメータによる Issue およびプルリクエストの自動化について](/articles/about-automation-for-issues-and-pull-requests-with-query-parameters)」
- [Issue の作成](/articles/creating-an-issue)

担当者にお尋ねください

探しているものが見つからなかったでしょうか?

弊社にお問い合わせください