• 2024/9/27
• 4分

【GitHub】PR(プルリクエスト)のテンプレートの作成方法！

＼ アプリをリリースしました ／

友達や家族の誕生日をメモ！通知も届く-みんなの誕生日-

posted withアプリーチ

GitHubでPRテンプレートを作成する方法

公式リファレンス：リポジトリ用のプルリクエストテンプレートの作成

GitHubではプルリクエストのテンプレートを作成することが可能です。テンプレートを作成することで複数の開発者が作成するPRを決まったフォーマットに統一することができるようになります。

テンプレートファイルは「pull_request_template.md」というファイル名で中身はシンプルなテキストファイルでありMarkdown記法を用いて記述されます。拡張子の「.md」はMarkdownの略称です。

設置場所はルートディレクトリ直下や.githubディレクトリ直下などに配置します。

├── プロジェクトファイル
├── .github/
│       └── pull_request_template.md // ①
├── pull_request_template.md // ②

これで実際にPRを作成する際に以下のように自動でテンプレートに記載されている内容を反映してくれるようになります。

読み込まれるテンプレートファイルはデフォルトブランチに設定されているものになります。

PRテンプレートの中身

テンプレートの中身はMarkdown記法での記述になるので例えば以下のような感じになります。

pull_request_template.md
## 概要

<!-- 例：XX機能の追加、バグ修正 -->

## チケットリンク

<!-- 例：https://appdev-room.com/ -->

## 期限日

<!-- 例：2024/9/28 -->

## やったこと

## 影響領域

<!-- 例：〇〇画面 -->

## 動作確認方法

## 備考

Markdown記法とは？

Markdown記法とは文書の書式設定やスタイルを指定するための軽量マークアップ言語の1つです。テキストに任意のマークアップを追加することで、簡単に文書を変換することができます。例えば、タイトルを作成するには、先頭に#を、リスト作成は行頭にハイフン(-)や数字を付けます。

# タイトル
## 小見出し
### 見出し3

- リスト1
- リスト2
- リスト3

1. 数字付きリスト1
2. 数字付きリスト2
3. 数字付きリスト3

**太字**、*斜体*、~~取り消し線~~

以下 区切り線
--- 
___
***

```
function test() {
  console.log("notice the blank line before this function?");
}
```

[リンクのテキスト](http://example.com)

>>>>>>Hello World

テンプレートファイルを複数管理する

テンプレートファイルを複数用意して、PR作成時に適したものを選択して使用するようにするためにはPULL_REQUEST_TEMPLATEディレクトリを作成してその中にテンプレートファイルを複数格納しておきます。

├── プロジェクトファイル
├── .github/
│       └── PULL_REQUEST_TEMPLATE/
│                ├── feature_template.md
│                ├── bugfix_template.md
│                └── documentation_template.md

複数用意している場合はPR作成時URLに?feature_template.mdというように使用したいテンプレート名のクエリを付けてリクエストを送信する必要があるようです。

まだまだ勉強中ですので間違っている点や至らぬ点がありましたら教えていただけると助かります。

ご覧いただきありがとうございました。