约定式提交规范 (Conventional Commits)

格式

[可选 scope]: <描述>

[可选 正文]

[可选 脚注]

Type 类型

类型 说明
feat 新功能
fix 修复 bug
docs 文档
style 格式（不影响代码运行）
refactor 重构
perf 性能优化
test 测试
chore 构建/工具变动
revert 回滚

规则

  • type 小写，冒号后跟空格
  • 描述：现在时、首字母小写、不加句号
  • 空行分隔各部分

破坏性变更 (BREAKING CHANGE)

两种标记方式：

  • feat!: 描述
  • 脚注中写 BREAKING CHANGE: 描述

示例

feat: 添加用户登录
fix(api): 修复超时问题
docs: 更新 README
feat!: 删除废弃接口
Closes #123