提言: コミットメッセージの一行目には要求仕様を書け - Qiita

Deleted articles cannot be recovered. Draft of this article would be also deleted. Are you sure you want to delete this article? これは Git (や Subversion などのバージョン管理システム) にコミットする時により良いコミットメッセージを書くための提言です。この提言は特にメッセージの一行目だけを対象とします。せめて最も重要な一行目だけでも良いメッセージを書いて欲しいからです。提言をズバリ一言で表すと 一行目には要求仕様を書け です。 背景 プロジェクトによっていろいろ慣習の差はあるものの、一般的には「コミットメッセージの一行目は変更内容の要約を簡潔に書け」とされます。特に Git は、各コミットメッセージの一行目だけを取り出してそれを一覧表示するなど

[kazuya030]

同意しかねる / fix と add は違うから fix は削らないで欲しいような気もするんだけど /「どう直したか」より「どのバグを潰したか」の方が重要な場面は多い気がする。少なくとも1行目では。

[trashtoy]

それより Redmine や Backlog など適当な Issue tracking システムと連携させて、コミットログでは関係する課題IDを必ず明記することが大事。コメントがｇｄｇｄでもなんとかなる

[y-kawaz]

git commit -am "なんか色々やった"; git commit -am "先週やった作業をcommitしわすれてたのでとりあえず全部"; git commit -am "色々バグ潰した"; git commit -am "aaa"

[kazoo_oo]

あまり同意しかねる。ある要求仕様に対するバグフィクスが何度あっても同じようなメッセージが並ぶことになる。やたらと具体的な割には、何をしたのかが見えにくい。「どう変えたか」が結局必要なことも多いのでは。

[localdisk]

一番役立つTipsとしては「コミットメッセージは日本語で書け」があります。

[atsushifx]

コメント問題と一緒。WahtやWhyをきちんとかけということ

[tengo1985]

あんまり賛成でもないかな。OSSでこれをやられるとどれがバグ修正なのか一目で探しにくい。チケットとの関連付けとかGitHubみたいにタグがついてるならいいけど。

[k-holy]

コミットの粒度によるし、タスク管理ツールとの連携を前提にするかどうかでも変わってくる。慣習で決まるものでもないでしょう

[iori_o]

主語はプログラムではなく「このコミット」にしている。要求仕様はそれをひとまとめにした pull request に書くようにしている。要求仕様を満たす為にどんなコミットを積んだかわかるようにしておきたい。

[masutaka26]

PullReqestのSubjectだったら同意

[takaesu]

commit log コミットメッセージ

[airj12]

「(コミット)メッセージはプログラムを主語とする動詞句で」

[ham007]

こんな感じ？？ NG:「xxxしたときに発生する不具合を修正」 / OK:「xxx時にYYY妥当性チェックを実施する」

[paz3]

良いコミットメッセージは、そのコミットによってプログラムがどんな要件を満たすのかをプログラムを主語とする動詞句(原形・命令形)で書く。するとFixedやChangedは不要になる／ブコメにFixやAddは必要という意見も。

[lucky_pool]

丹精込めて考えたコミットメッセージはどれくらいの頻度かつどんな目的で振り返るのか。そう考えれば、だいたいで分かれば良いんじゃないかな。プルリクのタイトルだったら要求仕様書けば良いけど。

[yosuke_furukawa]

いいtips、多分英語の語彙力増やさないとサッと出てこないこともありそうだけど、そういう時はもう日本語で書いても良さ気。

[tmatsuu]

ようやく読んだ。とても良いと思う。心がけたい。

[kimutansk]

修正した「内容（この記事で言うと要求）」と、あと実装詳細を書く、がいつもやっている書き方ですかねぇ・・

[efcl]

gitのコミットメッセージについて。 最近は殆ど https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit この書き方かなー

[esper]

"とりあえずセーブ"ってのを見かけるｗ

[ledsun]

主語を省略するなら受動態を使うといい。 A Login password longer than 20 characters is allowed.

[ghostbass]

最近は最後の行にチケット番号書いてるけど先頭のほうがいいかな/　gitで日本語メッセージがまともに扱えるようになったの割と最近だからねえ

[hokorobi]

良いコミットメッセージの頭に Fixed: とか Added: とかをつけて、要件通りに動くようになったのか、要件が追加されたのかは知りたいかな。

[AmaiSaeta]

機能追加もフィックスも同じメッセージ(の1行目)になるというのはどうかと。 | "changed"程度の長さを問題視するなら、もう日本語で書いた方が良いし、 http://www.sonasphere.com/blog/?p=1319 を参考にするなら恐らく中国語最強。

[reoring]

たしかに

[nilab]

git - 提言: コミットメッセージの一行目には要求仕様を書け - Qiita

[aklaswad]

fixは使わないけどaddは使うなあ。ちょっと意識してみよう/うまくsubjectがまとまらない場合、ちゃんと本文で説明するのも大事かと。/関係ないけど本文一行目で「subjectは釣りです」ってやってみたくなった。今度試しにや

[sgtakeru]

主語を「プログラマ」から「プログラム」へ。

[src256]

日本語で…いやなんでもありません。

[muddydixon]

ケースバイケースだけど参考になる

[hiro_y]

「メッセージは プログラムを主語とする動詞句 で書くべきです。(そして主語はいつもプログラムなので省略します)」

[poponponpon]

迷ったら日本語で書いちゃえ

[kool_kreate]

並んだときのわかりやすさ

[richard_raw]

プログラマーを主語にするな、と。addとかmodifyばっかりになっていて厭なので実践してみます。

[ilolio]

"プログラムを主語とする動詞句"で変更を書け。"プログラマを主語にしてメッセージを書く"と情報が薄くなる。

[hidex7777]

git commit -m "It's rainy today" git commit -m "sleepy... damepo"

[a_suenami]

ブコメは賛否両論。僕は"わからなくもないが全面的同意はしかねる"立場。コミットは開発者同士のコミュニケーション手段なので"要求"じゃなくて"実装詳細"を書いていい。ただ情報量が少ないのはダメという点は同意。