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

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

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

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

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

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

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

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

  1. On GitHub, navigate to the main page of the repository.

  2. Above the file list, click Create new file.

    The New file button

  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. 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."

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

  6. コミットメッセージフィールドの下で、コミットを追加を現在のブランチか新しいブランチから選択してください。 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.

  7. Click Propose new file.

    Propose new file button

参考リンク

担当者にお尋ねください

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

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