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

git のコミットメッセージ用例集がほしい

tl;dr

git のコミットメッセージのちょっとした言い回し、英語でなんと言うのか迷ってる時間がもったいないのでリファレンスブックが欲しいけどナイので、自分で地味に探したり作ったりする旅に出なきゃいけなさそう。とりあえずその起点として現時点でわかってることを書き連ねてみた。

前提/課題

以前に @miyagawa さんのPodcast Rebuild でも直也さんとの話題に上がっていましたが、git のコミットメッセージで、「こういう時ってどういうメッセージが適当なんだろ・・」とか思うことがよくあります。

慣れた人はそういった経験の連続の中で、そういう迷いとか悩みみたいのもだんだん減ってくるのだと思いますが、ぼくのような趣味ベースの日曜プログラマ(日曜にかぎらないが/むしろ日曜仕事できるから)の場合、トライ&エラーを出来る機会じたいが少ないので、なかなか身についてこないのが厄介です。

正解的には、たんにそこで諦めず、というかそれはそれで受け入れてやり続ければよろしい、ということになりますが、それはそれとして何か補助ツール的なお手軽リファレンス&ハンドブックみたいのがあるといいな、とはぼくのような初心者サイドの人ほど思うのではないでしょうか。

まあ、だからといって「そんなときにはコレ!」とかいうオチがあるわけではまったくなくて、たんにこれまではそういった状況におちいるたびに、検索してはなんとなく良さそうなものを見つけるものの、そのURLをロストして、また欲しくなって検索して・・ということを繰り返してしまってヒドイので、自分用に「せめてこれ以上はヒドくならないように」という感じでこちらのエントリに対策的な情報をまとめておこうと。

対策

今までそういう場合によく読み返していたのは以下ですが、
コミットメッセージの書き方 - ククログ(2012-02-21)

内容は大変面白いものの用例が少ないんだよな・・とは思っていて。
ちなみに、同じブログの以下の続編も面白いんですが、
わかりやすいコミットメッセージの書き方 - ククログ(2013-04-24)

やはり本質論ぽい感じで、個人的には英語で言ったら単語帳、みたいのがほしいので、あらためて「git コミットメッセージ」とかで検索したところ、以下がヒットしました。
Git - 英語コミットコメントに使えるオシャレフレーズ集 - Qiita

あとシンプルですがこちらも参考になりました。
Git - コミットログお作法の資料 - Qiita

いずれもQiitaですね。いつもお世話になっております。
上記それぞれからまたリンクがどんどん派生したりしているので、とりあえずこれだけメモっておけば最低限のことはできるのかな・・どうなんだろ。

というかやっぱり、これを起点にさらに使える用例は溜めていきたいかな・・とくにクールではなくてもよいし。分かりやすくて使いやすくて、どんな状況でもパッとちょうど良いのが出てくるといいなと。

出典を明らかにして自分なりにリストを作ってレポジトリに公開、とかでもいいか・・

余談/周縁的課題

あとそれはそれとして、上記のように検索するときにしても「コミットメッセージ」と「コミットログ」とかで結構ソレの言い方がバラけてるのもググラビリティを落としてる(パッとほしい表現に辿り着けない)要因のひとつのような気が。
じゃあそもそものライナスさんなどの開発陣はどう呼んでるんだろ?と思って、秀和システムから出ている濱野純さんの『入門Git』を見ると・・

入門Git

入門Git

「コミットログメッセージ」とか「コミットのログメッセージ」と書かれていて、どちらにも属さない(笑)。さすが・・!という感じ。

もう一個手元にあった、オーム社から出ている方の『入門git』によると・・

入門git

入門git

ふむ、こちらは「コミットメッセージ」か。

あと、後から思い出したけどぼくがたぶんこれまで一番読み返しているであろうgitの入門書、秀和システムの『アリスとボブのGit入門レッスン』だと・・

アリスとボブのGit入門レッスン

アリスとボブのGit入門レッスン

こちらは「コミットメッセージ」。

ということで、まあ確かに、ここで意図している話自体はログというよりメッセージの側面の方が強いというか、ログはある意味自動的に取るもので、人間が人間に向けて残すのはメッセージじゃないの、という気もするので濱野さんの言われる「コミットログメッセージ」か多数派の(というか)「コミットメッセージ」というのが落とし所では、という気もしますがどうなのでしょうね。

以上です・・!

追記。こちらも参考になりました。
ChangeLog を支える英語 · GitHub

追記2。続編を書きました。
note103.hateblo.jp