Git 提交规范主流遵循 Conventional Commits(Angular 规范),用于统一团队协作、自动化生成 CHANGELOG、语义化版本。
一、标准格式(必背)
<type>(<scope>): <subject>
<body>
<footer>
- Header(必填):type(scope): subject
- Body(可选):详细说明原因、逻辑、影响
- Footer(可选):关联 issue、破坏性变更
二、Header 详解
1. type(类型,必填)
- feat:新功能(feature)
- fix:修复 bug
- docs:仅文档变更
- style:格式/空格/分号,不影响逻辑
- refactor:重构(无新功能/无 bug 修复)
- perf:性能优化
- test:添加/修改测试用例
- chore:构建/工具/依赖变更
- revert:回滚提交
2. scope(作用域,可选)
模块/组件/文件名,如:auth、api、ui、order。
3. subject(描述,必填)
- 祈使句、现在时:add 而非 added、adds
- 首字母小写,结尾无句号
- 控制在 50 字符内
三、Body 正文(可选)
- 空一行后书写,每行≤72 字符
- 说明为什么改、改了什么、影响范围
- 可分点(用
-或*)
四、Footer 脚注(可选)
- 关联 Issue:
Closes #123/Fixes #456 - 破坏性变更:
BREAKING CHANGE: 移除旧 API /v1/orders
五、示例最简单常用(工作中 90% 场景)
类型(作用域): 简短描述(动词开头、小写、无句号)
新功能
feat(user): 新增用户头像上传功能
修复 Bug
fix(order): 修复订单列表刷新不更新问题
文档修改
docs(readme): 更新项目启动说明
代码重构(不改功能、不改 Bug)
refactor(auth): 简化登录逻辑代码
样式调整(不影响代码逻辑)
style(button): 修复按钮间距与缩进
fix(标准版:带正文 + 关联 Issue)
fix(pay): 修复微信支付回调签名错误
- 修正签名算法参数顺序
- 增加日志输出便于排查线上问题
- 兼容旧版本回调格式
Closes #108
破坏性变更(标准版)
feat(api): 重构用户信息接口
BREAKING CHANGE: 移除 /api/v1/user 旧接口,使用 /api/v2/user
回滚代码(标准版)
revert: feat(pay): 接入微信支付
This reverts commit abc1234.
2888



被折叠的 条评论
为什么被折叠?



