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

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

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

This is the legacy workflow to create an issue template. We recommend using the upgraded multiple issue template builder to create multiple issue templates. 詳しい情報についてはIssue およびプルリクエストのテンプレートについてを参照してください。

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

You can add YAML frontmatter to each issue template to pre-fill the issue title, automatically add labels and assignees, and give the template a name and description that will be shown in the template chooser that people see when creating a new issue in your repository.

Here is example 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, octo-org/octo-team
---

Note: You must put YAML-reserved characters such as : in quotes. For example, ":bug: Bug".

To be included in the community profile checklist, issue templates must be located in the .github/ISSUE_TEMPLATE folder and contain valid name: and about: YAML front matter.

You can create default issue templates and a default configuration file for issue templates for your organization. 詳細は「Organization 用にデフォルトのコミュニティ健全性ファイルを作成する」を参照してください。

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

  1. On GitHub, navigate to the main page of the repository.

  2. Above the file list, click Create new file.

    The New file button

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

    • Issue テンプレートをリポジトリのルートディレクトリで表示するには、issue_template の名前を入力します。 たとえば、issue_template.md です。
      ルートディレクトリの新しい Issue テンプレート名
    • To make your issue template visible in the repository's docs directory, type docs/ followed by the name of your 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
    • Expected behavior and actual behavior
    • Steps to reproduce the problem
    • Specifications like the version of the project, operating system, or hardware
  5. At the bottom of the page, type a short, meaningful commit message that describes the change you made to the file. You can attribute the commit to more than one author in the commit message. For more information, see "Creating a commit with multiple co-authors."

    変更のコミットメッセージ

  6. コミットメッセージフィールドの下で、コミットを追加を現在のブランチか新しいブランチから選択してください。 If your current branch is master, you should choose to create a new branch for your commit and then create a pull request. For more information, see "Creating a new pull request."

    コミットブランチのオプション Templates are available to collaborators when they are merged into the repository's default branch.

  7. Click Propose new file.

    Propose new file button

参考リンク

担当者にお尋ねください

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

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