Commit messages are not titles

Salvatore Sanfilippo

コミットメッセージはタイトルではない

重要なのは、件名でもないということです。コミットメッセージの最初の行の末尾にはピリオドを付けるなと、誰もが言います。私もしばらくはその助言に従っていましたが、今日でやめます。コミットメッセージはタイトルでも件名でもないと思うからです。コミットメッセージは、そのコミットによって行われた変更の意味を要約するものです。つまり、短い文なのです。次の行に詳細を加えて、文をさらに補足することもできます。しかし、本文がなく、最初の1行しかないことも少なくありません。件名やタイトルだけのメールや記事を、どれくらい見かけるでしょう。ほとんどないと思います。ですから、私にとってはこういうものです。
これは、できるだけ情報密度を高くした、気の利いた要約です。
必要なら、長い版はこうなります。
1. 私はこれを行いました。
2. その結果、こうなりました。
3. 次の方法で再現できます。
だから、これからまた「末尾にピリオドを付けるな」と言われるたびに、この記事へのリンクを貼ることにします。
ただ、これはピリオドだけの問題ではありません。コミットメッセージの最初の行をタイトルだと考えると、書き方そのものが変わります。最初の行は、後に続く文章を導入するためのただのテキストになり、情報密度を高めようという意識がなくなります。コードを書くのが仕事なのですから、1行で非常に短く伝えられることなら、そうすればいいのです。そして、追加の情報は次の行に回せばいい。「タイトルなのだから」と考えて最初の行を犠牲にする必要はありません。
それに、プログラミングとは要約を書く技術でもあります。そうでなければ、本来よりもはるかに複雑なプログラムになってしまいます。だから、これは私たちにとってもよい練習なのかもしれません。

原文は Salvatore Sanfilippo により に公開されました。

この記事は「gpt-5.6-luna」を使用して翻訳されました。