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、修复积分商城支付成功后订单状态没有改变问题
"
相关推荐
l1t2 分钟前
测试clickhouse 26.3的新功能
数据库·clickhouse
oushaojun211 分钟前
git在项目中常用的操作集合
git
Mike117.11 分钟前
GBase 8a 批处理任务里的事务提交粒度和回滚边界
数据库
小江的记录本12 分钟前
【JEECG Boot】 《JEECG Boot 数据字典使用教程》(完整版)
java·前端·数据库·spring boot·后端·spring·mybatis
yjb.gz13 分钟前
Oracle物化视图概述
数据库·oracle
fundoit13 分钟前
MySQL Workbench中的权限设置不生效
数据库·mysql
ZzzZZzzzZZZzzzz…17 分钟前
MySQL备份还原方法2----LVM
linux·运维·数据库·mysql·备份还原
i220818 Faiz Ul18 分钟前
教育资源共享平台|基于springboot + vue教育资源共享平台系统(源码+数据库+文档)
java·数据库·vue.js·spring boot·论文·毕设·教育资源共享平台
M--Y19 分钟前
Redis常用数据类型-2
数据库·redis
不会写DN22 分钟前
SQL 单表操作全解
java·服务器·开发语言·数据库·sql