git commit 提交注释规范

来源:互联网 发布:otg摄像头软件 编辑:程序博客网 时间:2024/04/29 05:38

本文将介绍使用git commit时的注释规范,提高commit内容的可读性及理解。

规范说明:

1.用一空行分隔标题与正文。
2.标题使用大写字母。
3.标题不超过50个字符。
4.标题使用祈使语气。
5.标题不要使用句号结尾。
6.正文在72个字符处换行。
7.正文解释是什么和为什么,而不是如何做。


关键字:

Add 新增
Mod 修改
Del 删除
Fixed 修复


例子:

新增开放平台验证接口,Token支援多种调用方式,修复短信问题及删除废弃类

1.Add 开放平台验证接口, /OAuth/access_token,/OAuth/refresh_token
2.Mod Token类,修改为使用子类继承,支援多种Token调用
3.Mod Timer类增加ACCESS_TOKEN_TIMER常量
4.Fixed 验证码短信文字乱码问题
5.Del Model/UserType.php

3 0