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

Configuring issue templates for your repository

You can customize the templates that are available for contributors to use when they open new issues in your repository.

ここには以下の内容があります:

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

Creating issue templates

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

  2. リポジトリ名の下で Settings(設定)をクリックしてください。

    リポジトリの設定ボタン

  3. [Features] セクションの [Issues] の下で、[Set up templates] をクリックします。

    Start template setup button

  4. [Add template] ドロップダウンメニューで、作成するテンプレートの種類をクリックします。

    [Add template] ドロップダウンメニュー

  5. テンプレートをリポジトリにコミットする前にプレビューまたは編集するには、[Preview and edit] をクリックします。

    [Preview and edit] ボタン

  6. To edit the template, click , and type in the fields to edit their contents.

    Issue template edit button

  7. デフォルトの Issue タイトルを自動的に設定するには、リポジトリへの読み取りアクセスを持つ人に Issue を割り当てるか、ラベルを Issue テンプレートに適用し、こうした詳細な情報を [Optional additional information] の下に入力します。このような詳細情報を Issue テンプレートに、titlelabels、または assignees を YAML frontmatter フォーマットで使用して、追加することもできます。

    Additional info for issue template

  8. テンプレートの編集とプレビューが終了したら、ページ右上隅にある [Propose changes] をクリックします。

    [Propose changes] ボタン

  9. 変更内容を説明するコミットメッセージを入力します。

    Issue テンプレートコミットメッセージフィールド

  10. コミットメッセージフィールドの下で、テンプレートを直接デフォルトブランチにコミットするか、新しいブランチを作成してプルリクエストを開くか判断します。 プルリクエストに関する詳しい情報については「プルリクエストについて」を参照してください。

    Issue テンプレートの master へのコミットかプルリクエストを開くかの選択

  11. [Commit changes] をクリックしてください。 変更がデフォルトブランチにマージされると、コントリビューターがリポジトリで新しい Issue を開くときにテンプレートを使用できるようになります。

Configuring the template chooser

リポジトリで新しいIssueを作成する時に表示されるIssueテンプレートの選択画面は、.github/ISSUE_TEMPLATEフォルダーにconfig.ymlファイルを追加することによってカスタマイズできます。

You can require contributors to use issue templates by setting blank_issues_enabled to false. If you set blank_issues_enabled to true, people will have the option to open a blank issue.

Note: If you used the legacy workflow to manually create an issue_template.md file and enable blank issues in your config.yml file, the template in issue_template.md will be used when people chose to open a blank issue. If you disable blank issues, the template will never be used.

If you prefer to receive certain reports outside of GitHub, you can direct people to external sites with contact_links.

Here is an example config.yml file.

blank_issues_enabled: false
contact_links:
  - name: GitHub コミュニティフォーラム
    url: https://github.community/
    about: Please ask and answer questions here.
  - name: GitHub Security Bug Bounty
    url: https://bounty.github.com/
    about: Please report security vulnerabilities here.

Your configuration file will customize the template chooser when the file is merged into the repository's default branch.

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

  2. ファイルの一覧の上にある Create new file(新規ファイルの作成)をクリックしてください。

    新規ファイルボタン

  3. In the file name field, type .github/ISSUE_TEMPLATE/config.yml.

    Configuration filename

  4. In the body of the new file, type the contents of your configuration file.

    Configuration file content

  5. ページの下部で、ファイルに対して行った変更を説明する短く分かりやすいコミットメッセージを入力してください。 コミットメッセージでは、複数の作者にコミットを関連づけることができます。 詳しい情報については「複数の共作者を持つコミットの作成」を参照してください。

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

  6. コミットメッセージフィールドの下で、コミットの追加先を現在のブランチか新しいブランチから選択してください。 現在のブランチが master であれば、コミット先として新しいブランチを作成することを選択し、続いてプルリクエストを作成しなければなりません。 詳しい情報については「新しいプルリクエストの作成」を参照してください。

    コミットブランチのオプション

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

    新規ファイルの提案ボタン

参考リンク

担当者にお尋ねください

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

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