読者です 読者をやめる 読者になる 読者になる

パルカワ2

PerlとRubyとイチャラブ

コミットログを綺麗にする努力をする。

tech git

綺麗なコミットログとは

綺麗なコミットログとは、コミットログを見返す時に知りたい事を知れる。
コミットログを見返す時は、「なにをしたのか」と「なぜその変更を行ったか」を知りたい。つまり、「なにをしたのか」と「なぜその変更を行ったか」を書けば綺麗なコミットログになると言える。

ファイルを変更した場合

一行目:「何」に「どういった」変更を行ったかを簡潔に書く(要約)
二行目:改行がないとおかしいことになるので、二行目は必ず改行する
三行目以降:一行目に書いた変更を「なぜ」行ったかを書く
HogeViewはpiyo時にfugaするように変更

fugaしないと〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜が起きて
〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜で
〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜なので

フィードバックの対応などした場合

一行目、二行目は、変更した場合と同じ
三行目以降:フィードバックがあったコメントのURLを貼る
HogeViewはpiyo時にfugaするように変更 #928

とかイシューやプルリクに紐付けるだけだと、
イシューが大きい場合なぜそれを行ったのかわからないので、コメントや結論に紐付ける。

HogeViewはpiyo時にfugaするように変更

http://〜/issues/928#issuecomment-737255

よくある質問

必ず3行以上書かないと行けない?

そんな事ないと思う。
人間らしく臨機応変に対応していけばいいと思う。

コミットを細かく分ければ1行で良い?

そんな事ないと思う。
目的は、「未来の自分・他人がコミットログを見た時に、"修正内容(要約)"と"なぜそれを行ったか"が分かるようにする」なので、1行ではそれが難しいと思う。

社内向けに書いたものをブログにも書くメソッド