ChangeLog とトラッキング (Protra-members) - Protra

ChangeLogの書き方とトラッキングの利用法についてです。

私は無駄な要素は1 byteでも省きたくて、ChangeLogでは活用語尾や句点
をすべて省いてます。他のお二方は活用語尾がところどころありますし
、句点を必ず入れています。

活用語尾の揺らぎは気にすることはないと思うのですが、さすがに句点
の有無は目立つので統一したいです。入れたほうがいいですか？
＃ UNIX使いにありがちな私の無駄な改行も気になるので、これは
＃ 削除します。

それと、ChangeLogとcommit logには関係するトラッキングのリクエストID
を入れましょう。[種類 ID]という形式が一般的です。Feature Requests
の種類はFREと略します。

私もまだ慣れていなくてよく忘れるのですが、commitに至る議論や結論
を参照する上で、これは非常に重要です。それと、解決したリクエスト
の状態をCloseにするのを忘れずに。

逆に、対応するリクエストのないcommitもなるべく避けましょう。たと
え後付けでもトラッキングにリクエストがあったほうが、あとから追跡
するときに便利ですし、開発過程を眺めようとするユーザ(ひょっとする
と将来の開発者)に対しても親切です。

そういう意味では、荒井さんの[bugs #3975]は理想的なのですが、おし
いかな説明が少し不親切です。

ChangeLogは開発者にわかればいいんですけど、トラッキングはユーザに
親切にしておきましょう。それと解決したトラッキングはCloseです。Delete
は間違えたリクエストを削除するときに使います。

うるさいことをいろいろ言ってすみませんが、こういう細かい積み重ね
は、Protraプロジェクトの将来のためにきっと役に立ちます。

-- panacoran

__________________________________________________
Do You Yahoo!?
http://bb.yahoo.co.jp/

Protra

[Protra-members] ChangeLog とトラッキング