へ： 変更の理由を、差分に添える。
この言葉の意味
コードの差分だけでは、なぜその方法を選んだのかまでは伝わりません。困っていたこと、変更後の振る舞い、確かめた内容を短く添えると、レビューや将来の調査に役立ちます。処理を見れば分かる説明より、判断の背景を残しましょう。
たとえば、こんな場面で
理解を助けるための仮の場面です。
よくある場面
差分に「修正」とだけ書くと、レビューする人は、不具合への対応か読みやすさの改善かを推測することになります。判断の前提が共有されない例です。
こう変えてみる
「空の結果で画面が止まるため、空配列を返す」と困り事と変更を結び付けます。確認した入力例と、今回は扱わない範囲も添えます。
自分に問いかける
差分だけでなく、今それを変える理由も伝えていますか。
今日の実践ヒント
次の変更説明に、問題・変更後の動き・確認方法を一文ずつ書きましょう。