レビューしやすいPull Requestの説明文を書く | 実践講座

レビュー担当は差分を読めても、なぜ変更したかはコードだけでは分かりません。

テンプレート

## 目的
どの問題を解決するか

## 変更内容
- 利用者から見える変更
- 内部の主な変更

## 変更しないもの
今回の範囲外

## 確認方法
1. 実行手順
2. 期待結果

## リスク・確認してほしい点
互換性、権限、データ、迷った設計

大きめのPRでは、型・API契約、実装、テストの順など、理解しやすい順番を書きます。

PR作成後にFiles changedを読み、不要ファイル、デバッグログ、秘密情報、意図しない整形を確認します。