Skip to main content

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

リポジトリ用のプルリクエストテンプレートの作成

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

詳細については、「Issue と pull request テンプレートについて」を参照してください。

サポートしているどのフォルダーでも PULL_REQUEST_TEMPLATE/ サブディレクトリを作成し、pull request テンプレートを複数含めることができます。また、template クエリ パラメーターで pull request の本文に使用するテンプレートを指定できます。 詳細については、「クエリ パラメーターを使用して pull request を作成する」を参照してください。

ご自分の Organization または個人用アカウント向けに既定の pull request を作成することができます。 詳細については、「既定のコミュニティ正常性ファイルの作成」を参照してください。

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

  1. On your GitHub Enterprise Server instance, navigate to the main page of the repository. 1. ファイルの一覧の上にある、 [ファイルの追加] ドロップダウンを使用し、 [新しいファイルの作成] をクリックします。 [ファイルの追加] ドロップダウンの [新しいファイルの作成]
  2. ファイル名フィールドで:
    • pull request テンプレートをリポジトリのルート ディレクトリで表示するには、pull request テンプレートに pull_request_template.md という名前を付けます。 ルート ディレクトリの新しい pull request テンプレート名
    • pull request テンプレートをリポジトリの docs ディレクトリで表示するには、pull request テンプレートに docs/pull_request_template.md という名前を付けます。 docs ディレクトリの新しい pull request テンプレート
    • ファイルを非表示のディレクトリに格納するには、pull request テンプレートを .github/pull_request_template.md という名前にします。 非表示のディレクトリの新しい pull request テンプレート
    • pull request テンプレートを複数作成し、template クエリ パラメーターを使用して pull request の本文を埋めるテンプレートを指定するには、 .github/PULL_REQUEST_TEMPLATE/ と入力し、続けてお使いの pull request テンプレートの名前を入力します。 たとえば、「 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md 」のように入力します。 ルートまたは docs/ ディレクトリ内の PULL_REQUEST_TEMPLATE サブディレクトリに複数の pull request テンプレートを格納することもできます。 詳細については、クエリ パラメーターを使用した Issue と pull request の自動化に関するページを参照してください。 非表示ディレクトリ内の新しい複数の pull request テンプレート
  3. 新しいファイルの本文にプルリクエストテンプレートを追加します。 そこに盛り込むべき項目として、以下のようなものがあります:
    • ご自分のリポジトリ内の 関連する Issue への参照
    • プルリクエストで提案された変更の説明。
    • レビューを行っている提案された変更の責任を負う個人またはチームの @mentions
  4. ページの下部で、ファイルに対して行った変更を説明する短く分かりやすいコミットメッセージを入力してください。 コミットメッセージでは、複数の作者にコミットを関連づけることができます。 詳細については、「複数の共同作成者とのコミットの作成」を参照してください。 変更のコミット メッセージ 1. コミットメッセージフィールドの下で、コミットの追加先を現在のブランチか新しいブランチから選択してください。 現在のブランチがデフォルトブランチなら、コミット用に新しいブランチを作成してからPull Requestを作成すべきです。 詳細については、「新しい pull request の作成」を参照してください。 コミット ブランチのオプション テンプレートがリポジトリの既定のブランチにマージされると、コラボレーターがテンプレートを使用できるようになります。
  5. [新しいファイルの提案] [新しいファイルの提案] ボタンをクリックします

参考資料