ドキュメントには頻繁に更新が加えられ、その都度公開されています。本ページの翻訳はまだ未完成な部分があることをご了承ください。最新の情報については、英語のドキュメンテーションをご参照ください。本ページの翻訳に問題がある場合はこちらまでご連絡ください。
記事のバージョン: GitHub.com

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

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

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

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

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

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

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

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

    新しいファイル ボタン

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

    • プルリクエストテンプレートをリポジトリのルートディレクトリで表示するには、プルリクエストテンプレートの名前を入力します。 たとえば、pull_request_template.md です。
      ルートディレクトリの新しいプルリクエストテンプレート名
    • プルリクエストテンプレートをリポジトリの docs ディレクトリで表示するには、docs/ と入力し、続けてプルリクエストテンプレートの名前を入力します。 たとえば、docs/pull_request_template.md です。
      docs ディレクトリの新しいプルリクエストテンプレート
    • ファイルを隠しディレクトリに格納するには、.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. 新しいファイルの本文にプルリクエストテンプレートを追加します。 そこに盛り込むべき項目として、以下のようなものがあります:

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

    変更のコミットメッセージ

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

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

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

    Propose new file ボタン

参考リンク

担当者にお尋ねください

探しているものが見つからなかったでしょうか?

弊社にお問い合わせください