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

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

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

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

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

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

自分の Organization 用にデフォルトのプルリクエストテンプレートを作成できます。詳細は「Organization 用にデフォルトのコミュニティ健全性ファイルを作成する」を参照してください。

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

On GitHub, navigate to the main page of the repository.
Above the file list, click Create new file.
ファイル名フィールドで:
- プルリクエストテンプレートをリポジトリのルートディレクトリで表示するには、プルリクエストテンプレートの名前を入力します。たとえば、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 およびプルリクエストの自動化について」を参照してください。
新しいファイルの本文にプルリクエストテンプレートを追加します。そこに盛り込むべき項目として、以下のようなものがあります:
- リポジトリ内の関連する Issue への参照。
- プルリクエストで提案された変更の説明。
- 提案された変更のレビューを担当する個人やチームの@メンション。
At the bottom of the page, type a short, meaningful commit message that describes the change you made to the file. You can attribute the commit to more than one author in the commit message. For more information, see "Creating a commit with multiple co-authors."
コミットメッセージフィールドの下で、コミットを追加を現在のブランチか新しいブランチから選択してください。 If your current branch is master, you should choose to create a new branch for your commit and then create a pull request. For more information, see "Creating a new pull request."
Templates are available to collaborators when they are merged into the repository's default branch.
Click Propose new file.