Contents
優れたチェンジセットコメントの書き方
たいていの Mercurial 関連ツールは、 チェンジセット コメントの1行目をチェンジセットの短い説明として扱います。
ですから、1行目は電子メールの題名を書くつもりで書いてください:
- 1行で意味をなし、
- 半角65文字以内で、
- チェンジセットの概要を示している必要があります。
良い例
優れたチェンジセットコメントの例を以下に示します:
veeblefrotzer サブシステムでの最初のスタブ McWhirly/O'Blivet 法を用いて実装。 毎月12日には正しく表示されるが、 それ以外の27～30日はまだ動作しない。
以下の点で優れています。
- 1行目で変更内容が簡潔に記述されている
- コメント全体に過不足がない
- 既知の不具合について言及している
悪い例
これはダメな例です:
veeblefrotzer サブシステムを実装。沈降した whingnangle の envolvolution には McWhirly/O'Blivet の案を利用している。 手法の簡潔な説明については、 McWhirly, O'Blivet, "Acta Exsanguinata" 第3巻19章を参照のこと。誰かがそのページを 切り刻んでサイコロにしてしまって、その章が見当たらないということが 無い限りはね。
どの辺が問題でしょう?
- 1行目だけで意味が取れない
段落が別れていない → 読みにくい
- どうでもよいことが詳細に書かれている
関連項目
Mercurial へパッチを投稿する際は、コメントの書き方について Patch descriptions を参照