Differences between revisions 5 and 6
⇤ ← Revision 5 as of 2009-10-05 14:17:31 →
Size: 1642
Editor: YuyaNishihara
Comment: improved translation a bit. translated `good example'. ChangeSetComments r10.
← Revision 6 as of 2009-10-05 14:39:14 → ⇥
Size: 1710
Editor: YuyaNishihara
Comment: translated `bad example'.
Deletions are marked like this. Additions are marked like this.
Line 35: Line 35:
 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.		  veeblefrotzer サブシステムを実装。沈降した whingnangle の
 envolvolution には McWhirly/O'Blivet の案を利用している。
 手法の簡潔な説明については、 McWhirly, O'Blivet,
 "Acta Exsanguinata" 第3巻19章を参照のこと。誰かがそのページを
 切り刻んでサイコロにしてしまって、その章が見当たらないということが
 無い限りはね。
Line 47: Line 47:
 * どうでもよい詳細が書かれている  * どうでもよいことが詳細に書かれている

ChangeSetComments の翻訳です。

優れたチェンジセットコメントの書き方

たいていの 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行目だけで意味が取れない

  • 段落が別れていない → 読みにくい

  • どうでもよいことが詳細に書かれている

CategoryJapanese

JapaneseChangeSetComments (last edited 2013-09-04 16:27:29 by mpm)