githubのプルリクエストのテンプレート設定
githubでプルリクエストを送る時にどのような変更をしたのかの説明を記述すると思います。
そこでプルリクエストをするたびに毎回記述するのはめんどくさいですよね。
そこでリボジトリ直下に.github
フォルダを作りその中にPULL_REQUEST_TEMPLATE.md
を設定してあげるだけで、毎回記述する手間が省くことができます。
複数人で開発している場合でも、テンプレートを使うようにすれば統一され見やすくなると思います。
例(自サービスで使っているテンプレートの中身)
## 概要 - どこをどのように何のために変更したか ## チェック - [ ] コミットは適切にまとめられているか (レビュー後でもOK) - [ ] この変更にともなうドキュメントの更新はされているか - [ ] この変更にともなう必要なテストは書かれているか - [ ] マイルストーンは設定されているか (ない場合は作成) - [ ] レビュワーのアサインはされているか
このようにプルリクエスト時に記述された状態になってくれます。便利ですね!