リポジトリでIssueやプルリクエストのテンプレートを作成すると、コントリビューターはそのテンプレートを使い、リポジトリのコントリビューションのガイドラインに沿ってIssuelをオープンしたり、プルリクエスト中の変更を提案したりできるようになります。 リポジトリへのコントリビューションのガイドラインの追� に関する詳しい情� �についてはリポジトリコントリビューターのためのガイドラインを定めるを参照してく� さい。
You can create default issue and pull request templates for your organization or personal account. 詳しい情� �については「デフォルトのコミュニティ健全性ファイルを作成する」を参照してく� さい。
Issueのテンプレート
Issue テンプレートビルダー を使用してリポジトリの Issue テンプレートを作成する� �合、コントリビューターはリポジトリで新しい Issue をオープンするときに適切なテンプレートを選択できます。
Issue テンプレートは、コントリビューターが Issue の内容を指定できるようにするとともに、Issue をオープンするためのガイダンスを提供する� �合に役立ちます。
テンプレートビルダーを使うと、各テンプレートに対してタイトルと説明を指定し、テンプレートの内容を追� し、リポジトリ中でそのテンプレートをデフォルトブランチにコミットするか、プルリクエストをオープンできます。 テンプレートビルダーは、新しい Issue ページにテンプレートを表示するのに必要となる YAML front matter マークアップを自動的に追� してくれます。 詳しい情� �については、「リポジトリ用に Issue テンプレートを設定する」を参照してく� さい。
リポジトリで新しいIssueを作成する時に表示されるIssueテンプレートの選択画面は、.github/ISSUE_TEMPLATE
フォルダーにconfig.ymlファイルを追� することによってカスタマイズできます。詳しい情� �については、「リポジトリ用に Issue テンプレートを設定する」を参照してく� さい。
Issue テンプレートは、リポジトリのデフォルトブランチ中の� しディレクトリ .github/ISSUE_TEMPLATE
に保存されます。 テンプレートを他のブランチで作成した� �合、それをコラボレーターが使うことはできません。 Issue テンプレートのファイル名では大文字と小文字は区別されず、.md 拡張子が必要です。 コミュニティプロフィールチェックリストに含まれるためには、Issue テンプレートは .github/ISSUE_TEMPLATE
フォルダ内になければならず、適切なname:
およびabout:
YAMLフロントマターを含まなければなりません。
レガシーの Issue テンプレートワークフローを使い、手作業で単一の Issue テンプレートを Markdown で作成することもできます。その� �合、プロジェクトのコントリビューターは自動的に Issue の本文にテンプレートの内容を見ることになります。 また、アップグレードされた複数 Issue のテンプレートビルダー を使用して Issue テンプレートを作成することをお勧めします。 レガシーのワークフローに関する詳しい情� �については、「リポジトリ用の単一 Issue テンプレートを手動で作成する」を参照してく� さい。
セキュリティポリシーを作成して、プロジェクト中のセキュリティ脆弱性を� �告するための指示を出すことができます。 詳しい情� �については「リポジトリにセキュリティポリシーを追� する」を参照してく� さい。
プルリクエストのテンプレート
リポジトリにプルリクエストのテンプレートを追� すると、プロジェクトのコントリビューターはプルリクエストの本体にテンプレートの内容を自動的に見ることになります。
テンプレートは、リポジトリのデフォルトブランチに作成しなければなりません。 他のブランチに作成されたテンプレートは、コラボレーターが使用できません。 プルリクエストのテンプレートは、リポジトリの見えるルートディレクトリ、docs
フォルダ、または� しディレクトリ .github
に保存できます。 プルリクエストテンプレートのファイル名は大文字と小文字が区別されません。拡張子としては .md または .txt を使用できます。
詳細は「リポジトリのプルリクエストテンプレートを作成する」を参照してく� さい。