Git提交规范是一种标准化提交信息的约定,旨在提升代码协作效率与可追溯性。以下是核心内容:

基本格式 ✅

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

  • 类型:必填,如 feat(新功能)、fix(修复)、docs(文档)
  • 范围:可选,如 auth(认证模块)、api(接口层)
  • 描述:简要说明变更内容,动词使用现在时(如 update 而非 updated

类型规范 📋

类型 用途
feat 新增功能
fix 修复bug
docs 文档更新
style 代码格式调整
refactor 代码重构
perf 性能优化
test 测试用例增加
chore 构建流程或工具更新

⚠️ 注意:提交信息需简洁明确,避免模糊描述(如“修复了问题”应具体为“修复登录超时错误”)

示例 📌

feat/auth: 添加JWT身份验证支持  
fix/ui: 修复按钮点击无响应问题  
docs/README: 更新项目文档说明  

扩展阅读 📚

如需了解更详细的实践建议,可参考 Git提交最佳实践 页面。

Conventional Commit Message
Commit Type Examples