【Github】プルリク(Pull Request)の便利なテンプレ

職場のスゴい先輩から教えて頂いたプルリクのテンプレです。

# PR message template
- - - -
name: Pull Request Template
about: DefaultTemplate
title: ‘’
labels: ‘’
assignees: ‘’

- - - -

## 概要

<!—
* なぜこの変更をするのかなど、概要を記載
* 必要であればwikiやslackなどへのリンクを貼る
—>

* fix `#{issue_id}`


## 使い方

<!—
* 使い方の説明
* この Pull Request のレビュアーが、挙動を確かめる時に困らないように記述する
* 例えば、機能追加であれば、その機能の使い方やその機能までの動線
* バグであれば、その再現条件 (例えば、デバイスの状態、設定によってこういう風に使える、とかこういう画面が出てくる、とか条件があれば)
—>

## Request/Responseの主な変更点

<!— APIのレスポンスが変わった場合の変更点 —>

## 技術的変更点概要

<!—
* なにをどう変更したか
* ロジックがどういう手順で動くのか、
* レビュワーにわかるように、技術的視線での変更概要説明
—>

## DB変更点

<!—
* マイグレーションが必要な場合、その内容
—>

## テスト結果とテスト項目

<!—
していない場合はしていないと書いてください。

* [ ] テストする際の項目を、このように、チェック可能な形式で記載する。
* [ ] レビュワーがなるべく再テストできるように、具体的に書くこと
* [ ] 概要などと被る記述になるかもしれないけど、それでも書くこと
* [ ] 機能のON/OFF によって画面の出しわけ、機能が有効になったり無効になったりする場合、場合分けしてテスト項目を書く
—>

## 今回保留した項目とTODOリスト

<!—
箇条書きで書く。できれば次のissueを作る。

* あれこれを治す #xxxxxx
* あれそれを実装する #xxxxxx
—>