Differences between revisions 12 and 15 (spanning 3 versions)
Revision 12 as of 2013-08-30 07:25:37
Size: 1988
Comment: spam spam spam spam
Revision 15 as of 2013-09-01 02:18:59
Size: 641
Editor: AlvinQuin
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
#language ja
<<TableOfContents>>

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

たいていの Mercurial 関連ツールは、 [[ChangeSet|チェンジセット]] コメントの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行目だけで意味が取れない
 * 段落が別れていない &rarr; 読みにくい
 * どうでもよいことが詳細に書かれている

== 関連項目 ==
 * Mercurial へパッチを投稿する際は、コメントの書き方について [[ContributingChanges#Patch_descriptions|Patch descriptions]] を参照
----
CategoryJapanese

[[ChangeSetComments|English]], [[ThaiChangeSetComments|ภาษาไทย]]
Unquestionably the author is recognized Lise Lust then she feels most comfortable when people employ the full term. Administering databases is your partner day job presently and it's issue she really recognize. http://www.imageafter.com/image.php?image=b1menatwork006.jpg&dl=1 The thing she adores nearly all is to view books and at this point she is difficult to earn assets with it. For years she's been living in [[http://imageshack.us/photos/Western|Western]] Samoa. If you intend to find along with more check out his website: http://2013hogans.marineafric.com/hogan-lovers-shoes-c-17/hogan-lovers-shoes-0025-beige-silver-p-305.html/

Unquestionably the author is recognized Lise Lust then she feels most comfortable when people employ the full term. Administering databases is your partner day job presently and it's issue she really recognize. http://www.imageafter.com/image.php?image=b1menatwork006.jpg&dl=1 The thing she adores nearly all is to view books and at this point she is difficult to earn assets with it. For years she's been living in Western Samoa. If you intend to find along with more check out his website: http://2013hogans.marineafric.com/hogan-lovers-shoes-c-17/hogan-lovers-shoes-0025-beige-silver-p-305.html/

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