【github】プルリクエストのテンプレートを作成

github でプルリクエストのテンプレートを作成する方法をここにメモします。

参考

docs.github.com

ディレクトリ作成

「create new file」 ページへ移動

Githubの「<>code」ページより、「Create new file」をクリックします。

「.github」 ディレクトリを作成

テキストフィールドに「.github/」と入力します。入力後に、「.github」ディレクトリが作成されます。

テンプレートファイル置き場

デフォルト

「pull_request_template.md」 ファイルを作成

先ほど作った「.github」ディレクトリ内に「pull_request_template.md」と記載し、「Edit new file」にはテンプレート内容を記載します。

複数テンプレートが必要な場合

複数テンプレートが必要な場合は、「PULL_REQUEST_TEMPLATE」ディレクトリ を作成し、その配下にテンプレートファイルを置きます。使用する際は「template クエリ パラメータ」を指定するようです。(こちら検証はしてないです)

「PULL_REQUEST_TEMPLATE」 ディレクトリ を作成

先ほど作った「.github」ディレクトリ内に「PULL_REQUEST_TEMPLATE/」と入力しディレクトリを作成します。

「pull_request_template.md」 ファイルを作成

テキストフィールドに「pull_request_template.md」と記載し、「Edit new file」にはテンプレート内容を記載します。

テンプレート内容

# Issue
* Issue 番号を記載

# 実装内容
* このプルリクで何をしたのか記載

# 確認手順
## 準備
- 再現させるための環境構築方法を記載

## 実行コマンド
- 実行コマンド or 再現手順を記載

## 確認ポイント
- 期待している動作について記載

# その他
* このPRの補足事項

記載したら画面下部の「Commit new file」をクリックします。

プルリクエスト作成

プルリクエストを作成してみると、テンプレートが適用されます。