Commit messages are not titles

Salvatore Sanfilippo

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

原文は Salvatore Sanfilippo により に公開されました。 このブログを購読する

件名でもない。どちらでも本質的には同じことだが。誰もが「コミットメッセージの1行目の末尾にピリオドを打つな」と言う。私もしばらくはそのアドバイスに従っていたが、今日でやめることにした。コミットメッセージはタイトルでも件名でもないと思っているからだ。それはコミットがもたらす変更の意味を要約したシノプシスであり、つまり一つの小さな文なのだ。その文はコミットメッセージの後続の行で詳細を補足することもできるが、そもそも本文が*ない*ことも多い。あるのは1行目だけだ。件名だけ、タイトルだけのメールや記事をどれだけ見かけるだろうか? ほとんどないはずだ。だから私にとってはこういうことになる。

これは可能な限り情報密度の高い、気の利いた要約である。

そして必要なら、長いバージョンはこうだ。なぜなら:
1. 私はこれをやった。
2. そしてこうなった。
3. そしてこうすれば再現できる。

だから今後また「末尾にピリオドを打つな」と言われるたびに、この記事へのリンクを貼るつもりだ。

いや、ピリオドだけの問題ではない。コミットメッセージの1行目をタイトルとみなせば、書き方*そのもの*が変わってしまう。単に後続の文章を導入するためのテキストになってしまい、情報密度を高めようという意識が失われてしまうのだ。コーダーはコードを書くのが仕事だ。だから一行でごく短く伝えられることがあるなら、そうすべきだし、残りの追加情報は次の行に回せばいい。「タイトルだから」という理由で1行目を犠牲にする必要はない。

そもそもプログラミングとは要約を書く技術だ。そうしなければ、あるべき姿よりもはるかに複雑なプログラムが出来上がってしまう。だからこれは我々にとっても良い訓練になるのかもしれない。

この記事は「muse-spark-1.2-contributor」を使用して翻訳されました。

コメント