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

詳しくは、「Issueとプルリクエストのテンプレートについて」をご覧ください。

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

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

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

1. GitHub で、リポジトリのメイン ページに移動します。

2. ファイル リストの上にある [Add file ] ドロップダウン メニューを選んで、[ Create new file] をクリックします。

   または、左側のファイル ツリー ビューの をクリックしてもかまいません。

   

3. ファイル名フィールドで:

   • 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 を作成する」をご覧ください。

4. 新しいファイルの本文にプルリクエストテンプレートを追加します。 このテンプレートは、次を含むことを要求するように構成できます。

   • ご自分のリポジトリ内の 関連する Issue への参照。
   • プルリクエストで提案された変更の説明。
   • レビューを行っている提案された変更の責任を負う個人またはチームの @mentions。

5. [変更のコミット...] をクリックします。

6. [コミット メッセージ] フィールドに、ファイルに対する変更内容を説明する、短くわかりやすいコミット メッセージを入力します。 コミットメッセージでは、複数の作者にコミットを関連づけることができます。 詳しくは、「複数の作者を持つコミットを作成する」をご覧ください。

7. コミットメッセージフィールドの下で、コミットの追加先を現在のブランチか新しいブランチから選択してください。 現在のブランチがデフォルトブランチなら、コミット用に新しいブランチを作成してからPull Requestを作成すべきです。 詳しくは、「pull request の作成」をご覧ください。

   
   テンプレートがリポジトリの既定のブランチにマージされると、コラボレーターがテンプレートを使用できるようになります。

8. [変更のコミット] または [変更の提案] をクリックします。

参考資料

• Issueとプルリクエストのテンプレートについて
• Issue の作成
• pull request の作成