在通过svn或者git进行提交时,为了方便回顾提交历史回顾,需要对每个提交都添加日志,对于不同类型的提交需要做前缀说明,方便过滤。
一、日志标识符
标识符 | 说明 |
---|---|
feat | 新增功能(feature),或修改依赖库版本等,影响程序运转 |
fix | 修复bug,影响程序运转 |
test | 仅仅增删改测试代码、测试用例等 |
doc | 仅仅增删改文档,比如:README、CHANGELOG、CONTRIBUTE等 |
style | 仅仅修改了代码风格,或添加了注释等,比如格式化(不影响代码运转的变动) |
mix | 不知道如何分类的提交,比如提交了附件,或增加了一些工具 |
二、日志内容
除了需要指定标识符外,对于feat
、fix
的提交,还需要增加详细的日志信息,日志示例:
- feat
feat:【文件导入】增加批量文件导入功能
# 影响范围
文件导入
# 测试要点
测试是否可以一次导入多个文件
- fix
fix:【杀毒】解决病毒库加载失败问题
# 问题链接
http://jira.xxxx.xxx/xxxxxx
# 问题分析
是由于本地病毒库文件缺失导致加载失败
# 解决方案
增加本地病毒库文件存在判断,若没有,则从网上下载到本地
# 影响范围
文件导入时杀毒逻辑
# 测试要点
删除本地病毒库文件,测试是否可以自动从网上下载并加载成功
- test
test:增加了文件导入的测试用例
- doc
doc:增加了文件导入时序图
- style
style:格式化cpp文件
- mix
mix:增加格式化小工具和脚本文件