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

Git のコミットメッセージの先頭に issue の番号を書くようになった話

今まで、コミットと issue を関連付けるとき、コミットメッセージに

README を作成。close #10

という風に、末尾に issue の番号を書いてた。

「issue の番号をコミットメッセージの先頭に書いた方が、 コミット履歴を見たとき関連付いている issue の番号が先頭に並んで見やすいだろうな」とは思いつつも

close #10 README を作成。

という書き方が生理的に受け入れられなくて、今までずっと末尾に書くスタイルでやってきた。

じゃあなんで issue の番号を先頭に書くようになったかというと、つい先日、たまたま見た GitBucket のコミット履歴で

(refs #115) Display finger print on the ssh key setting page

という書き方を見て軽い衝撃を受けたから。「この手があったか!」って思った。 括弧で囲んでいるだけの違いなんだけど、見た目がタグっぽい。自分にとってはコロンブスの卵だった。

それからというもの、issue とコミットを関連付けるときはこのスタイルをマネして

(close #10)README を作成。

みたいに書いている。