よいコミットメッセージ・よくないコミットメッセージ - 弥生開発者ブログ

こんにちは、mzpです。 今日はMisocaのesaに書いていた「よいコミットメッセージ・よくないコミットメッセージ」という記事を紹介したいと思います。 あらすじ 開発チームでは「コミットメッセージには変更理由を書いて欲しい」「コミットメッセージはWhatよりもWhyが大事」という話を何度かしているのですが、なかなか徹底できていません。 ので、もう少し具体的に「こういうコミットメッセージはよくないですね」というまとめを作ってみることにしました。 ちなみにこの過程でみつけたコミットメッセージに、こんなものがあります。 一切情報がなくておもしろいですね。 ファイル移動を移動した事実しか書かない これは以下のようなコミットメッセージです。 ファイル名を変更 ディレクトリを移動 ファイルを移動したことはコミットメッセージを見なくてもdiffから分かりますが、なぜその移動をしたかが分かりません。 の

[fusionstar]

「一切情報がなくておもしろいですね」(今度やったら殺す)

[nazoking]

そんなお題目お説教より、コミットメッセージがうまく書かれていたから役に立った事例みたいなの出さないと有り難みないよ

[tekimen]

内容は確かにと思う反面なんでよくないコミットメッセージを書いてしまうのか。時間が足りない？仕事に対する姿勢？「レビューするときチャットでコミットはGitHubで」などの仕組みの問題？というのを考えてしまう

[t-wada]

"コミットメッセージには変更理由を書いて欲しい" "コミットメッセージはWhatよりもWhyが大事" "「こういうコミットメッセージはよくないですね」というまとめを作ってみることにしました" 基本中の基本こそ大事

[naopr]

ほとんど自分しかメンテしてないコードだとついついコミットメッセージが雑になってしまってごめんなさい

[hyujico]

読み手がどう捉えるのか想像してコメントを書けるかどうか。センスが問われるね。あとは、ちゃんとチケットが紐付いてればいいです。

[kakutani]

"レビュー対応2"

[nihonbuson]

ホント、「○○を修正しました」とだけ書かれたコミットメッセージとか止めてほしい。

[tasogare30]

レビュー指摘修正、ってコメントはホントよくないよねぇ。

[okbm]

rubocopppppppppってコミットダメなんかな

[sh19910711]

"コミットメッセージはWhatよりもWhy"

[tatsu_tora]

モデルやマイグレーション等、設計に関わる部分でも "レビュー対応" とか書かれると後から絶対わからなくなる

[tuto0621]

指摘があった場合はその内容を残すとよい

[uzuki-first]

コミットメッセージがコードのようにもっと露出する/重要視されるようになれば自然に良くなる気がするな。具体的な案がないんだけれども。

[braitom]

Whyを意識して書くのが大事。意識していてもめんどくさくて雑にコミットメッセージ書いちゃうときがあるんだよなあ。気をつけよう。

[teramako]

一番笑ったコミットメッセージ： https://github.com/vimpr/vimperator-plugins/commit/d26934599d3df506f21e1ead94483d4e351b703c

[takatama]

実例さらすの大事

[efcl]

https://leanpub.com/livingdocumentation でもこの辺色々書いてあって面白かった

[mikage014]

コミットログで企業文化が分かる。採用面接に行く時はコミットログを見せてもらうと良さそうだ

[everysick]

情報量がゼロなのはさすがに良くないけど、WhyというのはcommitよりもチケットやPRに書くべきな気がする。粒度と開発フローの問題なので一概に良し悪しは言えなさそう。

[toyama0919]

自戒

[n314]

理由を正直に書いたら、何となくファイル名を変更、良く分からないけどネットからのコピペで修正、とかになったりして。

[teracy_junk]

「コミットメッセージには変更理由を書いて欲しい」「コミットメッセージはWhatよりもWhyが大事」

[Nyoho]

「Misocaではコミットメッセージに理由を書くエンジニアを募集しています。」www

[nekonokokonekoshishinokokojish]

後からログ遡って「この文章だとわかんねーよ！」っていうの経験しないとなかなか身につかなかったりする。

[teto2645]

うちの自称プログラマーは何度注意してもまともなコミットメッセージを残しはしない。コード見ればわかるとしか言わない、コードに現れないところが重要なのに。さっさと切りたいわ…

[luccafort]

最初は気をつけてるんだけど気づくと「レビュー対応」みたいなコミットになってて良いコミットがなかなか浸透しないんだよね。 ツールで判断するには自然言語はなかなかにハードル高い。

[adwd118]

同意だけど「レビュー指摘対応」で全く問題ないと思う人も割と多くて、気にする派だけストレスで死ぬ

[kamei_rio]

レビュー指摘に対応したソースひとつひとつに細かくコメントを書くの？CI問題なければ許しても良いような気も

[Pasta-K]

レビュー対応よく見る

[to4iki]

わかる

[foostan]

大事

[m_seki]

コミットの理由は大切なので、コミットログにはチケットの番号しか書かない

[sonots]

理由クレクレ

[chikoshoot]

ソースのコメントにも言えることだな。（読んでない）