Skip to main content

Git 提交规范

提交格式

<type>(可选范围): <简短描述>

type 类型(核心就这几个)

类型含义示例
feat新功能feat(login): 添加登录验证码功能
fix修复 bugfix(user): 修复用户列表分页错误
refactor重构(不影响功能)refactor(table): 优化列表渲染逻辑
style纯样式/格式(不影响逻辑)style(button): 调整按钮间距
chore构建/工具/依赖变更chore: 升级eslint版本
docs文档修改docs: 更新部署说明

规则(简单版)

只记 5 条就够了:

1. 标题不超过 50 字

feat: 添加用户登录

2. 不要写废话

× fix: fix bug
√ fix(login): 修复验证码失效问题

3. 动词开头(推荐)

add / fix / update / remove / improve

4. 不要一句话太长

× feat: 修改了登录页面并优化了样式并修复了bug
√ feat(login): 优化登录页交互

5. 一个 commit 只做一件事

× 一个 commit 做 UI + bug + 重构
√ 拆开提交

团队最低标准

只强制这两点:

1. 必须有 type
2. 描述清晰,不允许 "update code" / "fix bug"

可选增强,不强制

如果想稍微规范一点点:

scope(模块)

feat(user): 新增用户导出功能
fix(order): 修复订单状态异常