Skip to main content

Issueとプルリクエストのテンプレートについて

Issue及びプルリクエストのテンプレートを使えば、コントリビューターがリポジトリでIssuleやプルリクエストをオープンする際に含めてほしい情報をカスタマイズし、標準化できます。

リポジトリでIssueやプルリクエストのテンプレートを作成すると、コントリビューターはそのテンプレートを使い、リポジトリのコントリビューションのガイドラインに沿ってIssuelをオープンしたり、プルリクエスト中の変更を提案したりできるようになります。 リポジトリへのコントリビューションのガイドラインを追加する方法の詳細については、「リポジトリ コントリビューターのためのガイドラインを定める」を参照してください。

Organization または個人アカウントのデフォルトの issue と pull request テンプレートを作成できます。 詳細については、「既定のコミュニティ正常性ファイルの作成」を参照してください。

Issueのテンプレート

Issue テンプレートビルダーまたは Issue フォームを使用してリポジトリの Issue テンプレートを作成する場合、コントリビューターはリポジトリで新しい Issue をオープンするときに適切なテンプレートを選択できます。

Issue テンプレートの選択肢が表示された新規 Issue ページ

Issue テンプレートは、コントリビューターが Issue の内容を指定できるようにするとともに、Issue をオープンするためのガイダンスを提供する場合に役立ちます。 コントリビューターが Issue をオープンするときに特定の構造化された情報を提供する場合は、Issue フォームを使用すると、必要な情報を確実に受け取ることができます。

テンプレートビルダーを使うと、各テンプレートに対してタイトルと説明を指定し、テンプレートの内容を追加し、リポジトリ中でそのテンプレートをデフォルトブランチにコミットするか、プルリクエストをオープンできます。 テンプレートビルダーは、新しい Issue ページにテンプレートを表示するのに必要となる YAML front matter マークアップを自動的に追加してくれます。 詳細については、「リポジトリ用に Issue テンプレートを設定する」を参照してください。

Issue フォームでは、GitHub フォーム スキーマを使用して、Web フォーム フィールドを含むテンプレートを作成できます。 コントリビューターが Issue フォームを使用して Issue をオープンすると、フォーム入力は標準のマークダウン Issue コメントに変換されます。 さまざまな入力タイプを指定し、必要に応じて入力を設定して、コントリビューターがリポジトリで実行可能な Issue をオープンすることができるようにすることができます。 詳細については、「リポジトリ用に Issue テンプレートを設定する」と「Issue フォームの構文」を参照してください。

リポジトリで新しい Issue を作成する時に表示される Issue テンプレートの選択画面をカスタマイズするには、.github/ISSUE_TEMPLATE フォルダーに config.yml ファイルを追加します。 詳しくは、「リポジトリ用に Issue テンプレートを設定する」をご覧ください。

Issue テンプレートは、リポジトリの既定のブランチの非表示 .github/ISSUE_TEMPLATE のディレクトリに格納されます。 テンプレートを他のブランチで作成した場合、それをコラボレーターが使うことはできません。 Issue テンプレートのファイル名では大文字と小文字は区別されず、 .md 拡張子が必要です。 Issue フォームで作成された Issue テンプレートには、 .yml 拡張子が必要です。 コミュニティ プロファイル チェックリストに含まれるためには、issue テンプレートは .github/ISSUE_TEMPLATE フォルダー内になければならず、有効な name: および about: YAML front matter を含む必要があります。

レガシーの Issue テンプレートワークフローを使い、手作業で単一の Issue テンプレートを Markdown で作成することもできます。その場合、プロジェクトのコントリビューターは自動的に Issue の本文にテンプレートの内容を見ることになります。 しかし、アップグレードされた複数 Issue のテンプレートビルダー または Issue フォーム を使用して Issue テンプレートを作成することをお勧めします。 従来のワークフローの詳細については、「リポジトリ用の単一 Issue テンプレートを手動で作成する」を参照してください。

セキュリティポリシーを作成して、プロジェクト中のセキュリティ脆弱性を報告するための指示を出すことができます。 詳細については、「リポジトリへのセキュリティ ポリシーの追加」を参照してください。

プル要求テンプレート

リポジトリにプルリクエストのテンプレートを追加すると、プロジェクトのコントリビューターはプルリクエストの本体にテンプレートの内容を自動的に見ることになります。

サンプルのプルリクエストテンプレート

テンプレートは、リポジトリのデフォルトブランチに作成しなければなりません。 他のブランチに作成されたテンプレートは、コラボレーターが使用できません。 pull request テンプレートは、リポジトリの表示されているルート ディレクトリ、docs フォルダー、または非表示の .github ディレクトリに保存できます。 pull request テンプレートのファイル名は大文字と小文字が区別されず、拡張子は .md または .txt などを使用できます。

詳細については、「リポジトリ用の pull request テンプレートの作成」」を参照してください。