コミットメッセージの流儀
大体は、1行目が説明、2行目が空白、3行目から詳しい説明を書くこと、としています。では、2行目に何か書くとどうなるのでしょうか。
2行目に記述があるコミットメッセージ
このように、2行目に何かしらを記述したコミットメッセージでコミットします。
これをgit logしてみると、このように表示されます。
GitHubでは、このように表示されます。
GitHub for Macでは、このように表示されます。
bitbucketでは、このように表示されます。
一見、何の問題もない
このように、webホスティングサービスでも問題なく表示されています。2行目に何か書くのは、書くと予期しない動作をするから、などという理由ではなさそうです。が……
git logの表示に問題が発生する
予期しない動作など発生しないと思っていたのですが、git log --onelineの表示が、以下のようになりました。1行目、2行目、3行目がひとつの行にまとまって表示されています。
そこで、以下のようにもっと長めのコミットメッセージを作成しました。
これをgit log --onelineしたところ、このようになりました。
結果から、どうやらgit log --onelineは、コミットメッセージの初めの空行までを読み取って1行に出力する動作をするようです(空行をはさんだ後の文章は表示されていない)。ソースコードを読んでないので推測になりますが。
まとめ
今回動作チェックをしなかったgit format-patchやgit amなどで、2行目に記述があるコミットメッセージが何らかの不具合を引き起こさないとも限りません。
特別な理由のない限り、コミットメッセージの2行目は空行にしましょう。