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

リポジトリ用に Issue テンプレートを設定する

コントリビューターがリポジトリで新しい Issue を開くときに使用できるテンプレートをカスタマイズできます。

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

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

Issue テンプレートを作成する

  1. GitHubで、リポジトリのメインページにアクセスしてください。
  2. リポジトリ名の下で Settings(設定)をクリックしてください。
    リポジトリの設定ボタン
  3. [Features] セクションの [Issues] の下で、[Set up templates] をクリックします。
    [Start template setup] ボタン
  4. [Add template] ドロップダウンメニューで、作成するテンプレートの種類をクリックします。
    [Add template] ドロップダウンメニュー
  5. テンプレートをリポジトリにコミットする前にプレビューまたは編集するには、[Preview and edit] をクリックします。
    [Preview and edit] ボタン
  6. テンプレートを編集するには、 をクリックし、フィールドに入力してコンテンツを編集します。
    [Issue template edit] ボタン
  7. デフォルトの Issue タイトルを自動的に設定するには、リポジトリへの読み取りアクセスを持つ人に Issue を割り当てるか、ラベルを Issue テンプレートに適用し、こうした詳細な情報を [Optional additional information] の下に入力します。 このような詳細情報を Issue テンプレートに、titlelabels、または assignees を YAML frontmatter フォーマットで使用して、追加することもできます。
    Issue テンプレートの追加情報
  8. テンプレートの編集とプレビューが終了したら、ページ右上隅にある [Propose changes] をクリックします。
    [Propose changes] ボタン
  9. 変更内容を説明するコミットメッセージを入力します。
    Issue テンプレートコミットメッセージフィールド
  10. コミットメッセージフィールドの下で、テンプレートを直接デフォルトブランチにコミットするか、新しいブランチを作成してプルリクエストを開くか判断します。 プルリクエストに関する詳しい情報については「プルリクエストについて」を参照してください。
    Issue template commit to main or open pull request choice
  11. [Commit changes] をクリックしてください。 変更がデフォルトブランチにマージされると、コントリビューターがリポジトリで新しい Issue を開くときにテンプレートを使用できるようになります。

テンプレート選択画面を設定する

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

blank_issues_enabledfalse に設定すると、コントリビューターに Issue テンプレートの使用を促すことができます。 blank_issues_enabledtrue に設定すると、空白の Issue を開くこともできます。

注釈: 従来のワークフローを使用して手動で issue_template.md ファイルを作成し、config.yml ファイルで空白の Issue を有効にした場合、空白の Issue を開くときに issue_template.md のテンプレートが使用されます。 空白の Issue を無効にすると、テンプレートは使用されません。

GitHub外で特定のレポートを受信する場合は、contact_links を使用して外部サイトにユーザを誘導できます。

config.yml ファイルの例は次のとおりです。

blank_issues_enabled: false
contact_links:
  - name: GitHub Community Support
    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.

設定ファイルでは、ファイルがリポジトリのデフォルトブランチにマージされるときにテンプレート選択画面をカスタマイズします。

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

  2. Above the list of files, using the Add file drop-down, click Create new file.

    "Create new file" in the "Add file" dropdown

  3. ファイル名フィールドに .github/ISSUE_TEMPLATE/config.yml と入力します。

    ファイル名の設定

  4. 新しいファイルの本文に、設定ファイルのコンテンツを入力します。

    ファイルコンテンツの設定

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

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

  6. コミットメッセージフィールドの下で、コミットを追加を現在のブランチか新しいブランチから選択してください。 If your current branch is the default branch, you should choose to create a new branch for your commit and then create a pull request. 詳しい情報については「新しいプルリクエストの作成」を参照してください。

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

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

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

参考リンク

Did this doc help you?

Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

OR, learn how to contribute.