« TortoiseHgからBTSチケットへリンクできるようになった | トップページ | ツールを設計技法の一つとして使いたい »

2010/11/27

SVNのコミットログの書き方

SVNのコミットログの書き方について記事があったのでメモ。

【元ネタ】
コミットコメントの書き方(我流) - 地平線に行く

僕は下記のようなコメントをコミットログに書くように奨励している。

【変更理由】プルダウンに特定の項目が表示されないバグを修正
【チケット】 #1234

1行目は、ソースを何故修正したのか、一言で書き表す。
2行目はチケットNoを書く。

ソースの修正理由は、修正内容よりも、修正した理由をできるだけ書いた方がいい。
ソースを差分比較すれば修正内容は分かるので、理由が一言でもあれば、ソースを理解しやすくなる。

コミットログにチケットNoを書いておくと、RedmineやTracはチケットとバージョン管理をリンクしてくれるので、謎のコミットが減る。
チケットに修正の発端となった要望やバグの内容を書いておけば、コミットログから修正理由の詳細をチケットへ遷移することで探しやすくなる。

何よりも、ソースから「yyyyMMddに障害管理No.xxxxの修正をした」などの無駄なコメントが消えて、ソースが綺麗になる。

コミットログがきちんと書かれてないと、ライブラリアンがリリースする時や、他の人がバグ修正する時に困る。
書いた本人すら、何故こんな変な修正を施したのか、理由もすぐに忘れるから。

チケットとリンクしておけば、チケットにソース修正の発端となったバグや仕様変更、問合せが分かるので、同類バグ調査などがやりやすくなる。

まちゅさんは上記の運用ルールを「No Ticket, No Commit!」と呼んでいた。
この運用ルールに一度慣れてしまうと、コミットログにチケットNoを書かないシステムは怖くて触れなくなる。

バージョン管理を使う人は全員、この運用ルールに慣れて欲しいと思う。

|

« TortoiseHgからBTSチケットへリンクできるようになった | トップページ | ツールを設計技法の一つとして使いたい »

Git・構成管理」カテゴリの記事

チケット駆動開発」カテゴリの記事

コメント

コメントを書く



(ウェブ上には掲載しません)


コメントは記事投稿者が公開するまで表示されません。



トラックバック

この記事のトラックバックURL:
http://app.cocolog-nifty.com/t/trackback/49479/50148442

この記事へのトラックバック一覧です: SVNのコミットログの書き方:

« TortoiseHgからBTSチケットへリンクできるようになった | トップページ | ツールを設計技法の一つとして使いたい »