👋 We've unified all of GitHub's product documentation in one place! Check out the content for REST API, GraphQL API, and Developers. Stay tuned for a blog post later today.


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

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

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

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

探していたものは見つけられましたか?

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

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

Organization またはユーザアカウントのデフォルトのプルリクエストテンプレートを作成できます。 詳しい情報については「デフォルトのコミュニティ健全性ファイルを作成する」を参照してください。

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

  1. GitHubで、リポジトリのメインページにアクセスしてください。
  2. ファイルの一覧の上にある Create new file(新規ファイルの作成)をクリックしてください。
    新規ファイルボタン
  3. ファイル名フィールドで:
    • プルリクエストテンプレートをリポジトリのルートディレクトリで表示するには、プルリクエストテンプレートに .github/pull_request_template.md という名前を付けます。
      ルートディレクトリの新しいプルリクエストテンプレート名
    • プルリクエストテンプレートをリポジトリの docs ディレクトリで表示するには、プルリクエストテンプレートに .github/pull_request_template.md という名前を付けます。
      docs ディレクトリの新しいプルリクエストテンプレート
    • ファイルを隠しディレクトリに保存するには、プルリクエストテンプレートに .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 であれば、コミット先として新しいブランチを作成することを選択し、続いてプルリクエストを作成しなければなりません。 詳しい情報については「新しいプルリクエストの作成」を参照してください。
    コミットブランチのオプション テンプレートがリポジトリのデフォルトブランチにマージされると、コラボレーターがテンプレートを使用できるようになります。
  7. Propose new file(新規ファイルの提案)をクリックしてください。
    新規ファイルの提案ボタン

参考リンク

探していたものは見つけられましたか?

担当者にお尋ねください

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

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