2日連続でGit運用系の話。
つらいコミットログ
意図がガチでわからんのコミットメッセージ
- wip
- review fix
- bug fix
これだと、「何のための」WorkInProgress(wip)なのか「どの」Review fixなのか、「どんな」Bug fixなのかがわからない。
そのため、「コミットログにはwhy」という部分に収束する
コードには How
— Takuto Wada (@t_wada) September 5, 2017
テストコードには What
コミットログには Why
コードコメントには Why not
を書こうという話をした
Whyの書き方
とはいえ1行でwhyを書くのはすごい大変なので、3行目以降を活用する。例えば
change mysql select target N+1が発生するので修正
のように1行目はざっと概要を書いて、3行目以降に具体的な「何故」を書く。
そうするとGitHub上では折りたたんで表示されるので見やすい
