commit log of first word

5.28日更新,大写关键词
12.01日更新,修改关键字,改为英文

俗话说『无规矩不成方圆』在提交代码到仓库(git或svn)中时,要遵循一定的格式,
所有的log以固定的引导词开始,之后简明扼要的说明,然后空一行,写上详细的说明(非必须),
这样做的好处是,方便从commit log中知道本次提交做了什么变更, 不用再去diff文件,省时省力。

整理了一下常用的commit log引导词:


Added ( 新增加的功能 )

Fixed ( 修复bug )

Changed ( 完成的任务,需求变更,任务发生变化 )

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

Improved ( 功能改进,完善 )

Finished ( 完成某项功能 )

Packaged ( 客户端打包构建结果,并标记版本号 )

从spmjs github上看到关键词都是大写的,遂觉得关键词大写,更容易区分。
故都改成大写了。


ADDED ( 新增加的功能 )

FIXED ( 修复bug )

CHANGED ( 完成的任务,需求变更,任务发生变化 )

UPDATED ( 完成的任务,由于第三方模块变化而做的变化 )

IMPROVED ( 功能改进,完善 )

FINISHED ( 完成某项功能 )

PACKAGED ( 客户端打包构建结果,并标记版本号 )

最新修改,改为中文关键字

增加 ( 新增加的功能 )

修复 ( 修复bug )

修改 ( 完成的任务,需求变更,任务发生变化 )

更新 ( 完成的任务,由于第三方模块变化而做的变化 )

改进 ( 功能改进,完善 )

完成 ( 完成某项功能 )

打包/发布 ( 客户端打包构建结果,并标记版本号 )

如:完成:出租车1.6,结束行程后推送抽奖界面

如果改的地方比较多,不能确认使用什么关键词,
可以拆分成多个功能点进行提交。(git推荐的方式)

------

后记:

commit log注释分为三段:动词,功能模块,变更说明。如:完成(动词):出租车1.6(功能模块),结束行程后推送抽奖界面(变更说明)


读一份好的git commit log,就像读一部长篇小说,一部鲜活的历史。