Git 提交规范
提交 Git 需规范
可以参考这个网站进行学习:https://www.conventionalcommits.org/en/v1.0.0/ ↗
目前最流行、也是最通用的标准叫做 Conventional Commits(约定式提交)。它的核心公式非常简单:
<类型>:<描述>
1. 核心关键词(Type)对照表#
| 关键词 | 什么时候用? | 举个例子 |
|---|---|---|
| feat | 新功能 (feature) | feat: 增加用户登录功能 |
| fix | 修 Bug | fix: 修复首页图片显示不出来的错误 |
| docs | 改文档 (documentation) | docs: 修改了安装步骤说明 |
| style | 格式修改 (不影响代码逻辑) | style: 删除了多余空格,格式化代码 |
| refactor | 重构 (既不是加功能也不是修Bug) | refactor: 把这段复杂的代码写得更整洁了 |
| perf | 性能优化 (performance) | perf: 让页面加载速度变快了 |
| test | 增加测试 | test: 加上了登录页面的自动化测试 |
| chore | 杂事 (构建过程或辅助工具的变动) | chore: 更新了第三方依赖库 |
为什么要分这么细?#
想象一下,半年后你回来看代码,或者你的同事要接手你的项目:
- 如果全是
update、111、完成,你根本不知道哪次提交改了什么。 - 如果是
fix: 修复登录闪退,你一眼就能定位到问题。
一个完美的 Commit 该怎么写?#
第一步:选好类型#
看看你这次改了什么。是加了代码?(feat)还是改了错别字?(docs)。
第二步:写好简述#
用一句简单的话描述你做了什么。建议不要超过 50 个字。
进阶版:详细说明(可选)#
如果你改动很大,可以在简述下面空一行,写更详细的内容。
示例:
feat: 增加购物车删除商品功能
- 修复了点击删除按钮没反应的问题
- 增加了删除前的二次确认弹窗
bash