BY Omutatsu
1647 字
8 分钟
Git用法
在使用Git管理版本的过程中,总是难以撰写提交消息
为了标准化提交内容,通常建议使用 Conventional Commits 约定提交格式
以统一乱七八糟的提交,方便检索查询版本历史
小声明Git 本身不内置 commit type,也不强制任何格式 以下“类型”是
Conventional Commits/Angular生态中的标准类型与常见扩展类型。团队应统一约定,并让 commitlint 等工具校验
Git提交格式
基本格式
从最基础的提交格式开始:
<类型>(<范围>): <描述>- 类型:这次改动的性质,比如 feat、fix
- 范围(可选):影响哪个模块,比如 auth、user
- 描述:简短的概述说明做了什么
让我们把内容写的更详细些:
<类型>(<范围>): <描述>
<正文>
<脚注:关联 issue、破坏性变更等>新增的两个内容:
- 正文:详述改动内容/解释为什么这么改
- 脚注:关联相关 issue、说明破坏性变更等等
举一个栗子:
feat(auth): 支持手机号验证码登录
新增手机号验证码登录流程,兼容原有密码登录。
Closes #123破坏性变更
对于破坏性变更,有些改动会破坏原有功能或接口
因此这类提交需要额外标记,提醒其他开发者注意
feat!: 移除旧版登录接口或者是
feat: 移除旧版登录接口
BREAKING CHANGE: 旧版 /login 已删除,请迁移到 /v2/login。国际化此处使用中文作为提交内容不太合适,仅演示作用
对于:
- 公开仓库:最好还是使用英语提交,提交内容使用祈使句
- 私人仓库:后续不公开使用中文问题不大,但还是建议使用英文养成好习惯
提交注意事项
很重要的注意事项!千万千万不要把api密钥一类的东西推送上去裸奔啊喂…
- 不提交敏感信息:密钥、令牌、密码、证书、个人配置
- 不提交生成产物:
dist、build、缓存、日志、依赖目录- 如果拷贝下来他人的仓库包含各种乱七八糟的生成产物,大部分完全用不上还占空间…是什么感觉呢
- 不提交无关文件:提交前检查
git diff --cached - 提交前运行测试、lint、格式化
- 重构与功能/修复分开提交
- 格式化与逻辑修改分开提交
- 不在主分支保留
wip提交,合并前 squash - 不写无信息提交:如
update、fix bug、修改 - 不把
BREAKING CHANGE当作 type - 不把
merge当作 Conventional type - 一个提交应可编译、可测试、可回滚
- 提交信息应能让 reviewer 快速判断影响范围
提交类型
这些是常见的提交类型,由 Conventional Commits/Angular 规定
编写提交描述时,如果想不起来该使用哪种提交类型,可以在下列表格中查询
(如果都难以作为合适的提交类型,可以使用万能的 chore)
| 类型 | 含义 | 使用时机 | 版本影响 | 示例 |
|---|---|---|---|---|
feat | 新功能 | 新增用户可见功能、接口、页面、配置项 | MINOR | feat(user): 增加头像上传 |
fix | 修复缺陷 | 修复 bug、异常、错误逻辑 | PATCH | fix(order): 修复优惠券重复计算 |
docs | 文档 | 只改文档,不影响代码运行 | 无直接 | docs(api): 补充接口说明 |
style | 格式 | 空格、缩进、分号、格式化,不改变逻辑 | 无直接 | style: 统一缩进为 2 空格 |
refactor | 重构 | 调整结构、重命名、提取函数,外部行为不变 | 无直接 | refactor(order): 提取金额计算逻辑 |
perf | 性能优化 | 提升速度、减少内存、优化渲染 | 无直接 | perf(list): 虚拟滚动减少节点 |
test | 测试 | 新增或修改测试代码 | 无直接 | test(user): 补充注册边界测试 |
build | 构建/依赖 | 构建工具、打包配置、依赖版本变更 | 无直接 | build: 升级 Vite 到 5.0 |
ci | 持续集成 | CI/CD 配置、流水线脚本 | 无直接 | ci: 增加 PR 自动检查 |
chore | 杂项 | 不影响 src/test 的日常事务 | 无直接 | chore: 更新 .gitignore |
revert | 回滚 | 撤销之前的提交 | 视被回滚内容 | revert: feat(user): 增加头像上传 |
其他常见扩展类型
| 扩展类型 | 说明 | 建议归属 |
|---|---|---|
deps | 依赖更新 | 可归 build 或 chore |
security | 安全修复 | 可归 fix |
release | 发布相关 | 可归 chore |
wip | 工作进行中 | 不建议进入主分支,合并前 squash |
hotfix | 紧急修复 | 可归 fix |
improvement | 改进 | 可归 feat/refactor/perf |
config | 配置调整 | 可归 chore/build |
init | 初始化 | 可归 chore |
examples | 示例 | 可归 docs |
merge | 合并提交 | Git 自动生成,不纳入 Conventional 规范 |
必须要声明的点以上这些不是标准提交类型 只不过在社区中其他开发者经常使用的到,因此请酌情使用
原则上:扩展类型宜少不宜多,要做到团队统一,并让 commitlint 等工具支持
“我们的约定”
这些是写提交时常见的社区约定,不管是给自己还是他人的仓库提交,都最好遵循以下约定:
- 一个提交只完成一件事:保证原子提交,可独立理解、测试、回滚
- 描述用祈使句、现在时:如“修复登录超时”,不要“修复了一些问题”
(绝对不是在内涵某软件的更新日志) - 英文约定:首字母小写,结尾不加句号;中文项目可统一中文,但 type 保持英文
- 长度控制:subject 建议不超过 50 字符,正文每行约 72 字符
- scope 可选:建议写模块名,如
auth、order、user,小写、无空格 - body 解释为什么:不是重复“怎么改”,而是说明背景、原因、影响
- footer 放关联信息:如
Closes #123、Fixes #456、Refs #789 - 破坏性变更必须显式说明:写清影响范围和迁移方式
- 关联 issue:推荐使用
Closes、Fixes、Refs - 签名与协作:需要时使用
Signed-off-by、Co-authored-by - 语言统一:中英文不要混用随意;术语保持一致
- 不重写公共历史:已推送的公共分支谨慎 rebase/force push
- 回滚用 revert:不要直接删除历史
- 合并策略统一:rebase、squash、merge 按团队规范执行
工具链与自动化
想批量处理规范,以下几个工具相当实用
commitlint:校验提交信息是否符合规范husky:Git hooks,提交前触发校验lint-staged:只检查暂存文件commitizen:交互式生成规范提交semantic-release/standard-version:自动生成 CHANGELOG 和版本号- 版本映射关系:
fix→ PATCHfeat→ MINORBREAKING CHANGE→ MAJOR