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

詳しい情報についてはIssue およびプルリクエストのテンプレートについてを参照してください。

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

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

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

2. ファイルリストの上にある [Create new file（新しいファイルを作成）] をクリックします。

   

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

   • プルリクエストテンプレートをリポジトリのルートディレクトリで表示するには、プルリクエストテンプレートの名前を入力します。 たとえば、pull_request_template.md です。
     
   • プルリクエストテンプレートをリポジトリの docs ディレクトリで表示するには、docs/ と入力し、続けてプルリクエストテンプレートの名前を入力します。 たとえば、docs/pull_request_template.md です。
     
   • ファイルを隠しディレクトリに格納するには、.github/ と入力し、続いてプルリクエストテンプレートの名前を入力します。 たとえば、.github/pull_request_template.md です。
     
   • プルリクエストテンプレートを複数作成し、template クエリパラメータでプルリクエストの本文に使用するテンプレートを指定するには、.github/PULL_REQUEST_TEMPLATE/ と入力し、続けてプルリクエストテンプレートの名前を入力します。 たとえば、.github/PULL_REQUEST_TEMPLATE/pull_request_template.md です。 複数のプルリクエストテンプレートをルートディレクトリや docs/ ディレクトリにある PULL_REQUEST_TEMPLATE サブディレクトリに格納することもできます。 詳細は「クエリパラメータによる Issue およびプルリクエストの自動化について」を参照してください。
     

4. 新しいファイルの本文にプルリクエストテンプレートを追加します。 そこに盛り込むべき項目として、以下のようなものがあります:

   • リポジトリ内の関連する Issue への参照。
   • プルリクエストで提案された変更の説明。
   • 提案された変更のレビューを担当する個人やチームの@メンション。

5. ページの下部で、ファイルに行った変更について述べた短く意味のあるコミットメッセージを入力してください。コミットメッセージ内でコミットを複数の作者に関連付けることができます。詳細は「複数の共同作者を持つコミットを作成する」を参照してください。

   

6. コミットメッセージフィールドの下で、コミットを現在のブランチに追加するか、新しいブランチを作成するかを判断してください。現在のブランチが master なら、コミットに新しいブランチを作成することにして、プルリクエストを作成してください。

   Templates are available to collaborators when they are merged into the repository's default branch.

7. [Propose new file（新しいファイルを提案）] をクリックしてください。

   

参考リンク

• Issueとプルリクエストのテンプレートについて
• 「クエリパラメータによる Issue およびプルリクエストの自動化について」
• プルリクエストの作成