[スレッド全体]

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. 機能改善や不具合改修と一緒に、コメントやインデント修正などを行っている

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

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


[▼次のスレッド]
INCM/CMT
Cyclamen v3.81
[ut:0.000][st:0.000]