万狼科技GIT使用规范


commit 代码提交规范

格式:

<type>(<scope>): <subject>

type:

类型 描述 例子
add 新增功能、模块等 add(用户模块):新增用户编辑个人资料功能
update 修改功能、模块等 update(用户模块):修改用户编辑个人资料不需要上传头像
delete 删除功能、模块等 delete(购物车模块):删除购物车批量删除商品功能
fix 修复BUG fix(购物车模块):修复购物车商品数量可以为负数
refactor 代码重构 refactor(全部):初始化系统架构
revert 撤销上次commit revert(用户模块):撤销修改用户编辑个人资料不需要上传头像
style 代码风格更改 style(会员中心):格式化代码
docs 修改文档相关内容 docs(api):更新API文档

cope:

用于说明本次commit的影响范围,比如具体功能或模块、控制器层、业务层、模型层等,视项目不同而不同。例如:pc/controller/update

subject:

本次commit的简单描述,一般不超过50个字符。推荐以动词开头,如:新增、修改、设置、撤销等等。