はてなブックマーク - コミットメッセージの書き方

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

タグ : Git バージョン管理 Programming 開発 development プログラミング subversion commit ソフトウェア communication

コンピュータ・IT 511 users

はじめに「分かりやすいコードを書く」、「コードと一緒にテストも書く」等はソフトウェア開発において大切なことです。しかしそれと同じくらい大切なことして「分かりやすいコミットメッセージを書く」があります。これはあまり着目されていなく、見過ごされていることです。今回は、コミットメッセージの分かりやすさの大切さ、そして、分かりやすくするための書き方を説明します。コミットメッセージとその大切さバージョン管理システムとコミット現在、ほとんど全てのソフトウェア開発ではSubversionやGitなどのバージョ... > このページを見る

最終更新時間: 2012年02月22日00時58分

▼ブログで紹介する

みんなのブックマーク人気（10）新着

teramako
"fix typo"で済ませる派（この場合はdiff結果で一目瞭然なので）。あと、無理して英語で書いて後で分からなくなるんだったら日本語にしちゃう派。 2012/02/22
retlet
主に140文字で今何してるか書いてる 2012/02/22
p260-2001fp
簡潔でわかりやすく誰にでも理解できるような英文のコミットメッセージを考えているうちに一日が過ぎたでござる。メソッド名すら悩む自分はこの簡潔って所が難しい。行き着くところがコード見りゃ解るじゃまずいよな 2012/02/22
tomoya cvs, development, education
各種有名リポジトリ毎のスタイルを比較してみると良いかも。僕は最近、個人のリポジトリはEmacsスタイルを使っています。"* file name (do) message" という感じ。 2012/02/23
udzura programming, dev, communication
良いコミットメッセージのためには、他の人のコミットを読むことも重要そう（特に英語は、定型表現がいっぱいあるだろうし、そういう表現を使っていくのも大事そう 2012/02/22
nazoking
違うことやってるな。僕がお願いしているのは「レビュアーへの説明のつもりで、そのコミットの内容と理由を書くべし（チケットでもいい）」あとredmineに「refs #000 タイトル」を簡単にコピペできる欄作った 2012/02/24
fukken
typoごときに何文字も打ち込むとかえってノイズになる 2012/02/22
ledsun
大事なのは同意。具体的にどう書くかは現場次第。 2012/02/22
tasogare30 あとで読む, プログラミング
コミットメッセージを日記に使ってごめんなさい！ 2012/02/22
naga_sawa 開発, tips
コミットメッセージはちゃんとかこう/英語コメントのテンプレが欲しい… 2012/02/29

site159 subversion
すいません　超適当です　たまに 2012/03/20
ghostbass programming, SCM, バージョン管理
書き方 2012/03/14
y-kawaz バージョン管理, Git
日本語です。サーセン。 2012/03/14
ginpei 外国語, svn, git
長すぎず短すぎず、一般的な言い回しで分かりやすく。特に英語で記述する際にどうあるべきか。 2012/03/123 RT
3 RT
- @SE_O_T 良記事 RT @ginpei_jp 長すぎず短すぎず、一般的な言い回しで分かりやすく。特に英語で記述する際にどうあるべきか。
hidehish
見てる: 2012/03/02
an-ironic-man プログラミング, 仕事
コミットの概要を必要十分な分量で。あとはWhyも書くとよい。基本的な書き方はプロジェクトで決まっていたほうがよい。 2012/03/01
naga_sawa 開発, tips
コミットメッセージはちゃんとかこう/英語コメントのテンプレが欲しい… 2012/02/29
ippei-r development
日本人のみのプロジェクトなら英語書く必要はないと思う。 2012/02/28
zonoise
Work on つかおう 2012/02/28
authorNari 5, git
commit 2012/02/27
d4-1977
気をつけたい。 2012/02/25
dasman74 バージョン管理
参考になる 2012/02/25
nazoking
違うことやってるな。僕がお願いしているのは「レビュアーへの説明のつもりで、そのコミットの内容と理由を書くべし（チケットでもいい）」あとredmineに「refs #000 タイトル」を簡単にコピペできる欄作った 2012/02/24
joker1007 development, scm
基本的に英語で書くようにはしてる。時々ごめんなさいしてるけど・・・。後、サブジェクト行は英語だけど、説明日本語とかあるな。止めないと。 2012/02/23
richard_raw 開発, git, clip
統一されたスタイルは大事ですね。svnだけど参考にします。 2012/02/23
kakutani clearcode, commitlog
"「分かりやすいコードを書く」、「コードと一緒にテストも書く」等はソフトウェア開発において大切なことです。しかしそれと同じくらい大切なことして「分かりやすいコミットメッセージを書く」" 2012/02/23
umiyosh
コミットメッセージの書き方 - ククログ(2012-02-21) (via Instapaper) Sent from my iPhone 2012/02/23
toshiyukino
英語で書けるように 2012/02/23
willnet git
言語は英語にする／一文の場合にはピリオドを付けない／主語は省き時制は現在の文章形式にする／文頭の英単語を大文字にする 2012/02/23
windish development, english
参考になる 2012/02/232 RT

2 RT