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

by shigemk2

当面は技術的なことしか書かない

分かりやすいコミットログを書くこと

Git

分かりやすいコミットログを書くべき理由

コミットを分かりやすくするべき理由について。コードとコミットは常に一緒に読まれる。
なので、一緒に読まれるコードと同じように、コミットも分かりやすいことが大切である。
つまり、コードと同じくらいに、コミットはソフトウェア開発の作業の重要な成果物となる。

コミットをわかりやすくするためには以下の2つの条件を満たす必要があるそうな。

  1. コミットの内容が分かりやすく説明されていること
  2. コミットの内容が小さくまとまっていること

分かりやすい説明について

1. 長すぎず短すぎず
コミットメッセージは長すぎても短すぎても分かりにくくなる。
コードを読まなくてもコミットログを見ただけでどんな修正をしたか分かるようにすることが重要である
逆に言うと、コードを読まないとどんな修正をしたか分からないコミットログはアウトである。

適度に改行を入れるのがよい。

repository: Fix bug in opening a repository in a certain case

There is a bug in opening a repository through a working
directory path.

Fix it by ensuring that the path to the .git directory ends
with a forward slash.

2. 短すぎるのもダメ

一言「バグを直した」だけなのはあまりにも不親切なので、「どこの」バグを直したのかを明言すること。

コミットの内容を小さくまとめる

1つのコミットでどうすればよいかを考えるのではなく、一連のコミットでどうすればよいかを考える。
そうすると、つのコミットにどこまで含めればよいかを考えやすくなります。
「コミットの流れを見ているだけでペアプログラミングしている気分になる」コミットが小さくまとまっているコミットがベスト。

たとえば、typoの修正とインデントの修正は別々のコミットに落とすべきである。