コミットコメントについてのブログのてきとー訳

James Lorenzen's Blog: Commit Comments: A Conversation with your Future Self
の画像は「バック・トゥ・ザ・フューチャー」のマーティ(マイケル・J・フォックス)とその両親だと思う。
なんか面白そうだったのでこれも訳そうとしたが、、、うーんよくわからん

メモ代わりにとりあえずさらしときます。Google翻訳よりはちょっとマシという程度ですけど。




コミットコメント:未来の自分との対話

僕はある機能やバグどこでなぜ入ったのかについてヒントを見つけるためにしばしばsubversionのコミットログを探しているのに気づいた。

たいていは数時間を無駄にし、毎回コミットコメントのなかの対話の欠如からフラストレーションを感じていた。

僕は変更をコミットするときにこの機能を見渡すことの重要性について強調できない。

多くの開発者はこれを昼食をはやくとることを妨げる30秒だと見なしているようだ。

開発者が本当になすべきことはこれは未来の自分への対話のように見せかけることなのだ。

今から半年後に君はコメントをみてなぜ自分がこの変更をしたのかわからないだろう。

これが僕が何が変わったのかなぜ詩が人に知られたすべてのバージョンで異なっているのかの説明的なサマリを持った瞬間だ。

何も僕はケビン・コスナーの脚本を求めているわけではない。ただもっと明確にしてほしいだけだ。平均的には僕のコメントは1-3文だ。重要な変更の場合は僕は以前段落を使っていた 

5単語より少ないコメントを見ると気が狂いそうになる。そんなのをたくさん見てきたけど。

元来た道に戻るためにキャンプする人がマシュマロのようなものを使って跡を
つけた映画を見たことがあるかい?

マシュマロのようなコミットコメントが問題の謎を解決するのを助けることや
もっと説明的なコミットコメントを書くことの習慣づけを考えてみよう。

他の便利なツール

Jira subversion pluginは僕がすきなものの1つだ。僕のチームでは問題追跡システムとしてJiraを使っている。Jira番号なしのコミットは無い。これはsubversionのpre-commit hookを使って強制しているからで、だからどの開発者もJira番号をコメントに入れることをしなければならない。Jiraではファイルの変更やコメントをみるために下にSubversionのコミットのリンクがある

subversionのpre-commit hookを使うことにはもう1つ利点がある。

それはHudson Jira Pluginを使うことだ。ビルドが成功するとhudsonはコミットコメントからJira番号を抽出し、特定のビルドに統合されリンクを含んだ状態のコメントをJiraに追加する