Git 提交规范

Git 提交规范 ​

提交信息格式 ​

<类型>(<范围>): <描述>

[可选的正文 - 说明主要变更、影响范围等]

常用类型 ​

类型 说明
feat 新功能
fix 修复 bug
docs 文档变更
style 代码格式（不影响功能）
refactor 重构（不是新功能也不是修复）
perf 性能优化
test 测试相关
chore 构建/工具变更

提交示例 ​

bash
# 简短格式
git commit -m "feat(order): 添加订单导出功能"
git commit -m "fix(user): 修复登录超时问题"
git commit -m "chore: 更新依赖版本"

# 多行格式（详细说明）
git commit -m "$(cat <<'EOF'
feat(api): 添加用户分页查询接口

- 支持条件筛选
- 支持排序
- 修复分页偏移错误

Closes #123
EOF
)"

注意事项 ​

  • 使用中文描述，简洁明了
  • 描述回答"做了什么"而非"怎么做的"
  • 范围可选，如 feat(order) 可简写为 feat

好与坏的对比 ​

✅ feat(order): 添加订单导出功能
✅ fix(api): 修复订单状态更新失败问题
✅ chore: 更新 vscode 配置

❌ update
❌ 修复bug
❌ 改了东西
备案号： 湘ICP备2021015274号-3