Git commit comment 汇总标准

　　参考汇总互联网其它文章建议，结合PEP 257 Docstring Conventions的描述，总结的Git 注释风格，作为个人执行的标准。内容如下：

 

遵循标准：

　　1，所有注释尽量坚持使用英文，如果用中文，尽量使用UTF-8编码。

　　2，注释要清晰，只有修正、改错、升级等标识，而没有其他内容等于没说。

　　3，每个提交解决一个或一类问题。提交做好任务的分组，一个改动不一定一次提交完成，一次提交不一定完成所有改动。

 

书写标准：

　　1，第一行：为简要总结，长度不超过 50字，采用命令式用语。首字母用大写，结尾不使用标点符号。

　　3，第二行为完全空行，不要tab键或空格键产生的空白行。

　　4，第三行开始，是对改动的详细介绍，可以是多行内容，建议每行长度不超过 72。可以包括原因、做法、效果等很多内容，一切你认为与当前改动相关的。

　　为何是72长度呢？因为 git log 输出的时候能显示得比较好看， 前面4个空格作为缩进，后面留4个空格机动（英文按单词排版）。

　　5，注释加前缀分类，用几个动词开始：

　　Added (新加入的需求)

　　Fixed (修复bug )

　　Changed (完成的任务)

　　Updated (完成的任务，或者由于第三方模块变化而做的变化)

　　假如有 Issues 系统，其中可以包含 Issue 的 ID。比如：Issue #123456

　　=================================================================

　　Mod: remove unused code, 表示修改（Modify）

　　Add: a new module to have faster process, 表示新增（Add）

　　Rem: deprecate unused modules, 表示移除（Remove）

　　Ref: improved the implementation of module X, 表示重构（Refactory）

 

备注：

　　如果配置了自动发送邮件，那么第一行就用来做邮件标题， 第三行开始的内容是邮件正文， 第二行是分隔线，用于区分两者。第一行被认为是个“标题”，也会作为邮件标题， 而标题是不需要标点的。

　　前缀的冒号后面跟一个空格比较好看。 为了控制字符串长度，子模块名称可适当缩写，但应保持统一。

 

参考文章：

　　http://www.fwolf.com/blog/post/14

　　http://segmentfault.com/q/1010000000395039

 

转载于:https://www.cnblogs.com/kylinfish/p/4159586.html