41:PRに不要な差分を持たせないようにしよう

プログラミング迷子: 私の手間は少ないほうが良い

  • 先輩T:さっきレビュー依頼されたPRだけど、100行近くある差分のほとんどが行末のスペース削除みたいだね。

  • 後輩W:はい、気になったのでついでに直しました。

  • 先輩T:実際にレビューするべき箇所を探すのが大変なんだけど……。

  • 後輩W:えっ(せっかく直したのに)、修正しないほうがいいですか?

  • 先輩T:そうですね、このPRの目的ではないので、こういう別の目的の修正は、別のPRにしてください。

  • 後輩W:でもそれだとブランチ作ったりPR書いたり手間じゃないですか。

  • 先輩T:その手間を実装者がやらなかった分、レビュー時間が延びてレビューアーの時間が使われていくんだよ。実装者なら簡単に分割できるけど、レビューアーは目的が混ざった状態から見始めるので、頭の中で分類しながらレビューするのはとても大変で時間がかかるんだよ。

ちょっとした問題に気づいて、それを修正するのは良いことのように思えます。 しかし、前述の例ではちょっとした修正がレビューの邪魔になってしまっています。 1つのPRに複数の目的 が含まれていると、レビューで確認するべきことを見落としてしまいます。

cover

(中略)詳細は書籍 自走プログラマー をご参照ください

ベストプラクティス

以下のポイントを守りましょう。

  • PRの目的を1つに絞る。たとえば、ロジックの変更と単純なフォーマット変更は別のPRに分ける

  • ...

cover

(中略)詳細は書籍 自走プログラマー をご参照ください