Git and GitHub FAQ

Author

Ryo Nakagami

Published

2024-12-16

Modified

2025-12-03

GitHub

Q1: Pull Requestテンプレートの指定方法

クエリパラメーター template を使うと，PR本文にあらかじめ設定されたテンプレートを適用できる

https://github.com/<ORG>/<REPO>/compare/<BASE_BRANCH>...<HEAD_BRANCH>?quick_pull=1&template=<template-name>

と入力すると template で設定されたPRテンプレートの用いたPRを作成することが出来ます．?以降の領域がクエリパラメータ指定領域です．

パラメータ

<BASE_BRANCH>: PRのベースブランチ
<HEAD_BRANCH>: PRを作成するブランチ
quick_pull=1: この指定で「Pull Request作成ページ」に直接遷移
template=<template-name>: PR本文にあらかじめ設定されたテンプレートを適用

Q2: Pull Requestテンプレートの保存先

テンプレートはデフォルトブランチに置く必要がある
- main がデフォルトブランチの場合，テンプレートも main に置く必要がある
拡張子は .md や .txt などが使用可能
保存先は，リポジトリのルートディレクトリ，docs/ 以下, .github/ 以下

プルリクエストテンプレートはデフォルトブランチ以外には自動反映されません．サポートしているどのフォルダーでも PULL_REQUEST_TEMPLATE/ サブディレクトリを作成することで，複数のPRテンプレートを含めることができます．

構成例

.github
    ├── PULL_REQUEST_TEMPLATE
    │   ├── pull_request_template.md
    │   └── release_template.md
    └── workflows
        ├── create-release-branch.yml
        ├── label_generator.yml
        ├── post-pull-request.yml
        └── release_branch_merge.yml

GitHub

References