banner
NEWS LETTER

git提交简易规范

Scroll down

提交描述信息格式: <type>(<scope>): <subject>

类型 描述
add 新增功能
update 更新功能
delete 删除功能
fix 修复 BUG
refactor 代码重构
revert 撤销上次commit
style 代码风格更改
docs 修改文档相关内容

scope: 影响范围

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

subject: 简单描述

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

规范的提交信息示例:

1
2
3
4
5
6
7
8
add(用户模块):新增用户编辑个人资料功能
update(用户模块):修改用户编辑个人资料不需要上传头像
delete(购物车模块):删除购物车批量删除商品功能
fix(购物车模块):修复购物车商品数量可以为负数
refactor(全部):初始化系统架构
revert(用户模块):撤销修改用户编辑个人资料不需要上传头
style(会员中心):格式化代码
docs(api):更新API文档
其他文章
cover
Java
  • 23/01/16
  • 16:00
  • 1.1k
  • 5