git commit 提交信息规范

常见用法

复制代码
# 将暂存区内容提交到版本库, 进入 vi 命令界面输入提交信息
git commit

# 将某些已被跟踪的文件提交到版本库(包含工作区和版本库)
git commit [file1] [file2] [...]

# 将暂存区内容提交到版本库, 无需进入 vi 命令界面输入提交信息
git commit -m "message"

# 跳过 git add, 将所有已被跟踪的文件更改提交到版本库
git commit -am "message"

# 使用一次新的commit, 替代上一次提交
# 如果代码没有任何新变化, 则用来改写上一次commit的提交信息
git commit --amend -m "message"

约定格式

复制代码
// type和subject必需,scope、body、footer可选
<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>
1、type(必填)

commit提交类型,主要包含如下几种:

type 描述
feat 新增功能
fix 修复bug
merge 合并代码
ui 样式调整
refactor 重构(既不修复错误也不添加功能)
perf 优化相关,比如提升性能、体验
revert 回滚之前的commit
2、scope(选填)

commit 影响的范围, 可以是影响的文件名、模块名、组件名、国家等。

3、subject(必填)

commit的简短描述。

4、body(选填)

commit 具体修改内容, 可以分为多行。

5、footer

一些备注, 通常是 Breaking changes 或修复的 bug 的链接.

提交多行提交信息的方法

方法一(进入 vi 模式输入多行提交信息)
复制代码
# 进入 vim 命令界面
git commit

# 按下 i,进入 vim 的插入模式,将下面内容粘贴进入后,输入 :wq 回车即可
fix:修复购物车模块
1、修复用户无法添加购物车功能
2、修复购物车商品结算问题
方法二(命令行输入多行提交信息)
复制代码
# 第一步:输入第一行
git commit -m "fix:修复购物车模块

# 第二步:按下回车输入第二行、按下回车输入第三行 ...
1、修复用户无法加入购物功能

# 第三步:多行提交信息输入结束,尾部加上引号,回车完成提交操作
2、修复购物车商品结算问题"
方法三(粘贴提前写好的提交命令) ------推荐

提前在文本编辑器中写好准备执行的提交命令,复制粘贴到命令行中执行即可,如下所示:

复制代码
git commit -m "fix:用户模块、购物车模块
1、修复用户无法注册功能
2、修复购物车商品批量删除报错问题
3、修复积分商城支付成功后订单状态没有改变问题
"
相关推荐
Leo.yuan9 分钟前
不同数据仓库模型有什么不同?企业如何选择适合的数据仓库模型?
大数据·数据库·数据仓库·信息可视化·spark
小毛驴85010 分钟前
所有微服务部署都使用一个git地址,并且通过docker部署各个服务的情况下,如何编写mvn指令来处理各个服务。
git·docker·微服务
国王不在家18 分钟前
git 切换仓库后清理分支缓存
git
麦兜*25 分钟前
MongoDB 6.0 新特性解读:时间序列集合与加密查询
数据库·spring boot·mongodb·spring·spring cloud·系统架构
chat2tomorrow28 分钟前
数据采集平台的起源与演进:从ETL到数据复制
大数据·数据库·数据仓库·mysql·低代码·postgresql·etl
稻草人想看远方31 分钟前
关系型数据库和非关系型数据库
数据库
考虑考虑32 分钟前
Postgerssql格式化时间
数据库·后端·postgresql
千里码aicood40 分钟前
【springboot+vue】党员党建活动管理平台(源码+文档+调试+基础修改+答疑)
java·数据库·spring boot
TDengine (老段)1 小时前
TDengine 选择函数 Max() 用户手册
大数据·数据库·物联网·时序数据库·tdengine·涛思数据
驾驭人生1 小时前
Asp .Net Core 系列:Asp .Net Core 集成 Hangfire+MySQL
数据库·mysql·.netcore