ujihisa/vital.vim — Issue #9: コミットログの書き方についての提案
Author: thinca
Created: 2012-01-16 03:12:40+00:00
State: open

些細なことですが、コミットログの書き方についての提案です。
個人的に実施しているのですが、モジュールに対して変更を行った場合、
コミットログの先頭にモジュール名を書くようにするのはどうでしょうか。
これによって得られるメリットとして以下が挙げられるかと思います。

- コンテキストが絞られることにより、コメントが書き易くなる。
- Data.List.uniq() と書く代わりに単に uniq() と書ける。
- ログをざっと見たときにそれぞれが何に対する変更かわかりやすい。
- ルール付けすることで(多分)みやすくなる。

ちなみに「grep すれば特定のモジュールの変更だけを見れる」ってのもなくはないですが、
これは git 標準でファイル指定すれば見れるのでメリットにはなりませんね。

また、help だけ、spec だけに変更を行った場合はそれもあるといいかもしれません。

例: c5bb95be39e13ed6ea87a0ae3a4a43f95b3c292e
```
DateTime: help: Fixed typo.
```
先頭がモジュール名、続いて、help のみの変更だったので help: としています。

その他、書き方に対する修正案、別の案などもあると嬉しいです。
今のところルールがまったくないので、賛同が得られなくても、気に入った人だけが使う、というのもありだと思っています。