PRのテンプレート作成手順
チーム開発をしていて、必ず必要だと思ったので記事にしました。
今までなかった現場もあったので、あるととても良いです。
PRの内容がすっきりして、レビュー時にコミュニケーションコストが省けるし、何をやったのかcloseしてもわるのであるととても便利です。
無いチームは書くことをお勧めします。
作り方
$ cd 作りたいディレクトリに移動
$ mkdir .github
$ cd .github
$ touch pull_request_template.md
テンプレ中身(Markdown)
サンプル
## PRの概要
<!-- このPRの概要を記入してください -->
## レビューして欲しい箇所
<!-- PRで特にレビューして欲しい箇所を記載してください -->
## Draftにした理由(WIPでも良いと思う)
<!-- Draftにした理由を記載してください -->
## スクリーンショット
<!-- 作業した箇所のスクリーンショットなどあれば貼ってください -->
Before | After
------------- | -------------
<image src="" width="320">|<image src="" width="320">
## その他
<!-- レビュワーへの参考情報(実装上の懸念点や注意点などあれば記載) -->
上記の内容をマージすればマージ以降PRの入力欄にこの内容が反映されます。
まとめ
上記意外にもチーム内でいろいろ決めて追加していくと良さそう。これはあくまでも参考程度の内容です。