Pull Request を送る際の注意

Pull Request を送る際の注意

Pull Request を送るときには目的を明確にしてください。

目的が共有されていないとレビューアーが問い合わせる必要があり、これまでマージまでに時間がかかってきました。 状況によって端折ってもいいですが、意図的に端折っているという意識が必要です (単なるスペルミスの修正なら別に目的は不要など)

Pull Request は可能な限り、一つの Pull Request では一つに絞ってください。

一つの Pull Request で複数の目的の修正を混ぜないでください。 例えばリファクタリングしながら、機能追加をするのは避けてください。

リファクタリングの規模が少ない場合は許容される場合もありますが、 リファクタリングの Pull Request と機能追加の Pull Request を分けて行うことにより Pull Request のサイズが小さくなるのでレビューアーは速くレビューできるので早くマージできます。

変更量が限定されることにより、仮に Pull Request に問題があったとしても容易に検出できるので品質向上に寄与できます。

細かく Pull Request を分けるのは煩わしいと感じるかもしれませんが、結果として早くマージできることがほとんどです。

Pull Request の再作成に関して

目的あるいは手段が大きく変わった時には PR を再利用しようと考えず、新たな PR を作成するようにしてください。

1. これまでの作業内容を別ブランチに push すれば多くの場合、コードの一部を再利用できます。
2. これまでの経緯を知らない人でもレビューに参加しやすくなります。
3. 新たな PR 作成時にまとめを書くことで PR 作成者の頭の整理ができます。
4. PR マージ後に見るときに関係していない人が理解しやすくなります。