コミットメッセージの書き方 - 2012-02-21 - ククログ

はじめに 「分かりやすいコードを書く」、「コードと一緒にテストも書く」等はソフトウェア開発において大切なことです。しかしそれと同じくらい大切なことして「分かりやすいコミットメッセージを書く」があります。これはあまり着目されていなく、見過ごされていることです。 今回は、コミットメッセージの分かりやすさの大切さ、そして、分かりやすくするための書き方を説明します。 コミットメッセージとその大切さ バージョン管理システムとコミット 現在、ほとんど全てのソフトウェア開発ではSubversionやGitなどのバージョン管理システムを使っています。バージョン管理システムを使うことによるメリットというのは、ソフトウェアの変更が記録されていくことにあります。 具体的なメリットは3つあります。 ソフトウェアの調査がしやすくなることです。現時点でのコードと、そして変更の履歴とを組み合わせることで、それらから非常

[teramako]

"fix typo"で済ませる派（この場合はdiff結果で一目瞭然なので）。あと、無理して英語で書いて後で分からなくなるんだったら日本語にしちゃう派。

[retlet]

主に140文字で今何してるか書いてる

[p260-2001fp]

簡潔でわかりやすく誰にでも理解できるような英文のコミットメッセージを考えているうちに一日が過ぎたでござる。メソッド名すら悩む自分はこの簡潔って所が難しい。行き着くところがコード見りゃ解るじゃまずいよな

[udzura]

良いコミットメッセージのためには、他の人のコミットを読むことも重要そう（特に英語は、定型表現がいっぱいあるだろうし、そういう表現を使っていくのも大事そう

[tomoya]

各種有名リポジトリ毎のスタイルを比較してみると良いかも。僕は最近、個人のリポジトリはEmacsスタイルを使っています。"* file name (do) message" という感じ。

[fukken]

typoごときに何文字も打ち込むとかえってノイズになる

[atsukanrock]

こういうの公開してくれるの、助かるわー。ルールの中身自体はプロジェクトの特性に合わせて調整（例えば英語じゃなくて日本語とか）するとしても、叩き台にできる。

[shin1x1]

redmine連携してるから refs 任せになってるけど、やっぱりちゃんと書いた方が良いね。

[masutaka26]

コミットメッセージは修正のサマリ。分かりやすく書くことは未来の自分を含めた他の開発者への思いやり。

[naga_sawa]

コミットメッセージはちゃんとかこう/英語コメントのテンプレが欲しい…

[d_animal141]

コミットメッセージの書き方

[eriko315]

“言語は英語にする 一文の場合にはピリオドを付けない 主語は省き時制は現在の文章形式にする 文頭の英単語を大文字にする”

[m_shige1979]

英語って大事

[peroon]

小分けにするのが必然となる

[naopontan]

commit log

[terasyou]

コミットメッセージの書き方

[nanoha3]

コミットメッセージの標準化

[karronoli]

Gitスタイルっていうのがあるのか．参考にする．

[prototechno]

ソフトウェア開発では英語の読み書きが必要となります…だよなぁ…orz

[kyohei_hamada]

勉強になるなー

[tadahiko_kawana]

やっぱり英語かぁ。

[gelegele]

英語のコミットメッセージのお手本がほしかったとこでした

[atotto]

良い例：Fix a bug Add a test Implement nested comments Clean the parser code up Improve performance

[gin0606]

"コミットメッセージの書き方 - ククログ(2012-02-21)"

[vcc]

言語は英語にする 一文の場合にはピリオドを付けない 主語は省き時制は現在の文章形式にする 文頭の英単語を大文字にする

[kussun]

いちいち悩まずに済むように、自分なりのテンプレを考えておきたい。

[site159]

すいません　超適当です　たまに

[ghostbass]

書き方

[y-kawaz]

日本語です。サーセン。

[ginpei]

長すぎず短すぎず、一般的な言い回しで分かりやすく。特に英語で記述する際にどうあるべきか。

[hidehish]

見てる:

[an-ironic-man]

コミットの概要を必要十分な分量で。あとはWhyも書くとよい。基本的な書き方はプロジェクトで決まっていたほうがよい。

[ippei-r]

日本人のみのプロジェクトなら英語書く必要はないと思う。

[zonoise]

Work on つかおう

[authorNari]

commit

[d4-1977]

気をつけたい。

[dasman74]

参考になる