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

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

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

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

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

1. で、リポジトリのメイン ページへ移動します。 1. ファイルの一覧の上にある、 [ファイルの追� ] ドロップダウンを使用し、 [新しいファイルの作成] をクリックします。
2. ファイル名フィールドで:
   • pull request テンプレートをリポジトリのルート ディレクトリで表示するには、pull request テンプレートに pull_request_template.md という名前を付けます。
   • pull request テンプレートをリポジトリの docs ディレクトリで表示するには、pull request テンプレートに docs/pull_request_template.md という名前を付けます。
   • ファイルを非表示のディレクトリに� �納するには、pull request テンプレートを .github/pull_request_template.md という名前にします。
   • 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 テンプレートを� �納することもできます。 詳細については、「クエリ パラメーターを使用して pull request を作成する」を参照してく� さい。
3. 新しいファイルの本文にプルリクエストテンプレートを追� します。 そこに盛り込むべき� �目として、以下のようなものがあります:
   • ご自分のリポジトリ内の 関連する Issue への参照。
   • プルリクエストで提案された変更の説明。
   • レビューを行っている提案された変更の責任を� う個人またはチー� の @mentions。
4. ページの下部で、ファイルに対して行った変更を説明する短く分かりやすいコミットメッセージを入力してく� さい。 コミットメッセージでは、複数の作者にコミットを関連づけることができます。 詳細については、「複数の共同作成者とのコミットの作成」を参照してく� さい。 1. コミットメッセージフィールドの下で、コミットの追� 先を現在のブランチか新しいブランチから選択してく� さい。 現在のブランチがデフォルトブランチなら、コミット用に新しいブランチを作成してからPull Requestを作成すべきです。 詳細については、「新しい pull request の作成」を参照してく� さい。 テンプレートがリポジトリの既定のブランチにマージされると、コラボレーターがテンプレートを使用できるようになります。
5. [新しいファイルの提案] をクリックします

参考資料

• Issue と pull request テンプレートについて
• クエリ パラメーターを使用した Issue および pull request の自動化について
• pull request の作成方法