提言: コミットメッセージの一行目には要求仕様を書け - Qiita
これは Git (や Subversion などのバージョン管理システム) にコミットする時により良いコミットメッセージを書くための提言です。この提言は特にメッセージの一行目だけを対象とします。せめて最も重要な一行目だけでも良いメッセージを書いて欲しいからです。提言をズバリ一言で表すと 一行目には要求仕様を書け です。 背景 プロジェクトによっていろいろ慣習の差はあるものの、一般的には「コミットメッセージの一行目は変更内容の要約を簡潔に書け」とされます。特に Git は、各コミットメッセージの一行目だけを取り出してそれを一覧表示するなど、一行目を特別に処理する機能が多いので、一行目にできるだけ多くの情報を凝縮させることは重要です。またメッセージを一行しか書かない不届きな慣習のプロジェクトでは、十分な情報を持たないメッセージは無用の長物と化します。 良くないコミットメッセージ しかし私は、情
コミットログを綺麗にする努力をする。 - パルカワ2
綺麗なコミットログとは 綺麗なコミットログとは、コミットログを見返す時に知りたい事を知れる。 コミットログを見返す時は、「なにをしたのか」と「なぜその変更を行ったか」を知りたい。つまり、「なにをしたのか」と「なぜその変更を行ったか」を書けば綺麗なコミットログになると言える。 ファイルを変更した場合 一行目：「何」に「どういった」変更を行ったかを簡潔に書く（要約） 二行目：改行がないとおかしいことになるので、二行目は必ず改行する 三行目以降：一行目に書いた変更を「なぜ」行ったかを書く 例 HogeViewはpiyo時にfugaするように変更 fugaしないと〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜が起きて 〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜で 〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜なので フィードバックの対応などした場合 一行目、二行目は、変更した場合と同じ 三行目以降：フィードバ
Gitのコミットログ再考 - Qiita
始めに 基本的には、開発はGitで行っています。自分的にはコミットログというのはちゃんと整形しましょう、そうするとあとで何が起きたかトレースするのが楽ですよ、という感じなのですが、意外にもこの辺りについて意識されないようなので、自分の私見を書いておきます。 基本的な情報 基本的には、Erlang が規則としているコミットログが参考になるでしょう。自分は、Gitを使い始めてから二年間ほど、下のようなコミットログを書いています。 このような形式に落ち着いた理由として、まずどの類の修正なのか。何かを追加したのか？何かを修正したのか？それともただ消しただけなのかを明確にします。 そして、そのあとに何処に対して、「追加」あるいは「修正」をしたのか。自分の開発は、基本Webが多いので、だいたい「MVC」か、あるいは「テスト」か、最近だと「ドキュメント」や「レビュー」の類も多いです。 次に、それが属する
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
