ChangeSetComments の翻訳です。

良いチェンジセットコメントの書き方

多くの ["Mercurial"] 関連ソフトウェアは[:ChangeSet:チェンジセット]コメントの最初の行を[:ChangeSet:チェンジセット]の内容を簡潔に記述したもとして取り扱います。

ですから最初の行は電子メールの題名を書くつもりで書いてください。

などが重要です。

良いコメントの例: 

 First stab at the veeblefrotzer subsystem

 Implemented using the McWhirly/O'Blivet technique.

 Displays correctly on the twelfth of every month,
 but doesn't yet work during the other 27-30 days.

以下の点で優れています。

悪いコメントの例: 

 Implemented the veeblefrotzer subsystem, which uses the
 McWhirly/O'Blivet scheme for envolvolution of the subducted
 whingnangle.  See McWhirly, O'Blivet, "Acta Exsanguinata", vol. III,
 chap. 19 for a concise description of the technique, unless you can't
 find the chapter because someone has razored it out and papered it to
 the walls of their cube.

以下の点が問題でしょう。