git commit 提交信息规范_git提交备注规范

作者：正经夜光杯 | 2024-06-21 02:00:30

踩

git提交备注规范

常见用法


# 将暂存区内容提交到版本库, 进入 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、修复积分商城支付成功后订单状态没有改变问题
"

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/正经夜光杯/article/detail/741607