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

ここには以下の内容があります:

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

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

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

You can create default pull request templates for your organization or user account. 詳しい情報については「デフォルトのコミュニティ健全性ファイルの作成」を参照してください。

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

1. GitHubで、リポジトリのメインページにアクセスしてください。

2. ファイルの一覧の上にある Create new file（新規ファイルの作成）をクリックしてください。

   

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

   • To make your pull request template visible in the repository's root directory, name the pull request template pull_request_template.md.
     
   • To make your pull request template visible in the repository's docs directory, name the pull request template docs/pull_request_template.md.
     
   • To store your file in a hidden directory, name the pull request template .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 およびプルリクエストの自動化について」
• プルリクエストの作成