代码提交日志规范

1. 提交注释要求

代码提交必须写日志信息。

2. 基本理念

日志信息内容要简明扼要，说明为什么做这个修改/提交代码。

就如同给另一个开发人员交谈一样，说清楚为什么要修改，以及其他需要给对方澄清的内容。

该说明的要点一定要写，但也不要长篇大论。

3. 格式要求

• 针对redmine上某个开发特性或问题提交的代码

svn ci -m "commit description. (#1234)" ...

日志信息中最后的"#1234" 是必须包含的，用于与redmine上的任务单关联。（注意“#”要用英文字符的）

每次代码提交只应该与一个redmine单相关。

• 对于没有相关redmine单的代码提交

svn ci -m "simple commit description." ...

注意：此种场景仅限于非常小的代码调整，大的代码修改应在Redmine上增加任务单以便跟踪。