Skip to main content

このバージョンの GitHub Enterprise はこの日付をもって終了となりました: 2023-01-18. 重大なセキュリティの問題に対してであっても、パッチリリースは作成されません。 パフォーマンスの向上、セキュリティの向上、新機能の向上を図るために、最新バージョンの GitHub Enterprise にアップグレードします。 アップグレードに関するヘルプについては、GitHub Enterprise サポートにお問い合わせく� さい

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

この記事では、次の� �目が扱われます。

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

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

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

Issueのテンプレート

Issue テンプレートビルダーを使用してリポジトリの 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 front matter を含む必要があります。

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

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

プル要求テンプレート

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

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

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

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