Pull Request Template を作ってレビューのラリーを減らす¶

はじめに¶

Code Review を行う際にコンテキストの共有が不十分なために、コミュニケーションのラリーが長くなったり、Reviewer の負担が大きくなることがある。コミュニケーションのラリーが長くなると、マージするまでの時間が長くなったり、コンフリクトが発生する確率が高くなる。Reviewer の負担が大きくなると、レビューの優先度が下がってしまったり、レビューの質が下がってしまう。 Reviewee、Reviewer 両方にとって良くない状況であり開発者体験を損なうため、Code Review に必要な情報はあらかじめ共有しておくことが重要である。

そこで、Pull Request Template を作成して、コンテキストの共有をしやすくすることでレビューのラリーを減らすことを目的とした。加えて、チームに新しくメンバーが入ってきた際に、チーム開発としてのガイドラインを共有するためにテンプレートとして文章化することと文章として残すことで GitHub や LLM の検索に hit しやすくすることも目的とした。

Pull Request Template¶

<!-- Pull Request Templateによってコミュニケーションのラリーを短くし、素早くコードレビューを終えることが目的 -->

# 変更点の概要

# なぜこの変更を行うのか

<!-- この変更をマージすると何が嬉しいのか。何ができるようになるのか。どのような問題が修正されるのか -->

# 変更点の詳細

# 変更点のテスト方法、再現方法

<!-- この変更を確認できる手順を記述してください -->

## テスト結果、実行結果（ログなど）

<!-- このPull Requestによって期待した結果が得られたかがreviewerが手元で実行しなくても確認できるように、変更による結果やログを共有しましょう -->

# チケット link

# 注力してレビューしてほしい点

# 別 PR として考慮すること

## このスプリントの中で別 PR として出す予定のもの

<!-- そのPRのステータスがjiraから見えるようになっていますか？なってなければjiraチケットを作りステータスが見えるようにしましょう -->

## このスプリントでは別 PR として出さないが、今後のタスクとして必要なもの

<!-- チケットのリンクを貼ってください。チケットがなければ記述してください -->

# チェックリスト

全てのチェックボックスにチェックが入ると、この Pull Request はレビュー可能な状態になります。

- [ ] 機能の追加・変更に対するテストコードを書いている
- [ ] ローカル環境で静的解析とテストがうまくいくことを確認している
- [ ] 自分でセルフレビューを行っている
- [ ] 理解が難しい箇所にコメントを書いている
- [ ] 対応するドキュメンテーションも更新している