SAKURA Development BBS(UNICODE)

▼ 2014/10/12 (日) 17:19:59 suzz

Mozilla/5.0 (Windows NT 6.3; WOW64; rv:32.0) Gecko/20100101 Firefox/32.0

[2209] サクラエディタ開発者の方へのお願い

SVN へのコミットに関するお願いです。

コミットの際に、「変更した機能」や「修正した不具合現象」の詳細が分かる
ように書いていただけないでしょうか？

機能変更の場合、例えば、
「New: Grep拡張」
「Imp: PHPヒアドキュメント/C++ RowString/C# quoted String等対応」
と書かれているだけでは、どのような機能が増えたのか分かりません。
もう少し具体的にどのような機能を追加、変更したのか書いて
いただけないでしょうか？

不具合修正であれば、「不具合の原因」しか書かれていないことが多いです。
「バッファーオーバーラン」、「初期化不足」、「ハンドルリーク」など。
具体的にどのような操作を行うと、どのような問題が発生していたかが分からないと
修正が妥当なのか判断できませんし、動作確認もできません。

コミットログに source forge のチケット(patchunicode#xxx)や掲示板の
ID が書かれていますので、これらのページを見れば変更内容が分かることも
ありますが、できれば、チケットIDや掲示板IDだけではなく、チケットや
掲示板に書かれている内容も、詳細としてコミットログに一緒に書いて
いただけると、非常に助かります。(あちこちのページを見ずに済むので)

また、コミットの単位についても、別々の変更が一度にコミットされています。
例えば
1. 「typo修正」というコミットで、インデントの修正、コメントの修正、
ファイルヘッダの追加などを同時に行なっている
2. 不具合修正のコミットで、現象が似ている別の不具合を一度に修正している
3. 機能改善や不具合改修と一緒に、コメントやインデント修正などを行っている

など。
これら論理的に別々の変更は、分けてコミットしていただけると、
ソースコードの差分を見た際に、変更が把握しやすいです。

以上、ご検討、よろしくお願いいたします。

▼ 2014/10/13 (月) 00:09:06 もか

Mozilla/5.0 (Windows NT 6.1; WOW64; rv:32.0) Gecko/20100101 Firefox/32.0

[2210] Re:サクラエディタ開発者の方へのお願い

svn logを [patchunicode:#1234] 形式で書いてもらう。
なんと！このページでlogを見ると、リンクになります。
https://sourceforge.net/p/sakura-editor/code/HEAD/log/?path=/sakura/trunk2
リンクになっていないと、ご指摘の通り不便極まりないがリンクならなんとか許せないでしょうか。

トラッカーの変更内容は、一番上のところに書き、パッチの内容が変わったら一番上の本文も修正する。
wiki・この掲示板の内容は、要約か必要な個所を引用して、トラッカーに貼り付ける。
パッチをコミット後に不具合などが出た場合は、新しくトラッカーIDを発行する運用にする。
(新ID側からリンクすると、バッグリンクが旧ID側に表示されるのが便利だとおもう)
で、手を打たない？

この上のURLおよび、forkしてgit svn fetchなどで取り込んだ後のsvn logは、
後で修正しても反映されないらしいので、気に食わない。
　コミット後のパッチに対するバグとかあってもフォローできないし、
記述が間違っててもフォローできない。
というか、コミットそのものがめんどくさくなるので、私はそれならコミットしない。

▼ 2014/10/13 (月) 12:50:58 suzz

Mozilla/5.0 (Windows NT 6.3; WOW64; rv:32.0) Gecko/20100101 Firefox/32.0

[2211] Re2:サクラエディタ開発者の方へのお願い

> svn logを [patchunicode:#1234] 形式で書いてもらう。

チケット ID を書く時のキーワードを統一していただけると、BTS/ITS 連携機能が
使えるので便利ですね。

http://tortoisesvn.net/docs/nightly/TortoiseSVN_ja/tsvn-dug-bugtracker.html

>トラッカーの変更内容は、一番上のところに書き、パッチの内容が変わったら一番上の本文も修正する。
>wiki・この掲示板の内容は、要約か必要な個所を引用して、トラッカーに貼り付ける。

情報を「トラッカーの一番上の本文」に集められるのであれば、あとはコミットの時に
同じ文章をコピペすればよいと思うのですが。。。
そこまで頑張ったのなら、あともう一手間です。

リンクに対するコミットログの利点は、すばやく検索できることです。
ただ、svn だとサーバに接続しないとコミットログが検索できないので、
あまり恩恵は無いのかもしれないですが。

>この上のURLおよび、forkしてgit svn fetchなどで取り込んだ後のsvn logは、
>後で修正しても反映されないらしいので、気に食わない。
>　コミット後のパッチに対するバグとかあってもフォローできないし、
>記述が間違っててもフォローできない。

ちょっと意味を取り違えているかもしれないですが・・・

ソースコードと同様、コミットログも間違えないように気を付けてコミットするしかないと
思いますので、コミットログもレビューしてからコミットすればよいのでは？

[▼次のスレッド]

INCM/CMT
Cyclamen v3.81

[ut:0.010][st:0.000]