格式的提示信息
<type>(<scope>) : <subject>
<空行>
<body>
<空行>
<footer>
其中 type 的值可以有很多,下面有几个我们常用到的
. feat :新功能
. fix :修复bug
. doc : 文档改变
. style : 代码格式改变
. refactor :某个已有功能重构
. perf :性能优化
. test :增加测试
. build :改变了build工具 如 grunt换成了 npm
. revert: 撤销上一次的 commit
scope :用来说明此次修改的影响范围 可以随便填写任何东西,commitizen也给出了几个 如:location 、browser、compile,不过我推荐使用
all:表示影响面大 ,如修改了网络框架 会对真个程序产生影响
location: 表示影响小,某个小小的功能
module:表示会影响某个模块 如登录模块、首页模块 、用户管理模块等等
subject: 用来简要描述本次改动,概述就好了
body:具体的修改信息 应该尽量详细
footer:放置写备注啥的,如果是 bug ,可以把bug id放入
如:
<feat>(all):<数据库封装类 新增query_value函数;修改query_all_values函数名>
1. 新增query_value函数,用于查询单个字典的值
2. 修改query_all_values函数名为query_values,与query_value函数名照应
3. 修改query_pages函数的返回值total调用cls.query_one(sql).get('count') or 0 改为cls.query_value(sql=),便于代码可读性
4. 使用 -> type 明确DB数据库封装类的所有函数返回值类型