Conventional Commits(约定式提交)
格式:
<类型>[可选范围]: <描述>
[可选的正文]
[可选的脚注]
常用类型(Type):
| 类型 | 说明 | 版本号影响 |
|---|---|---|
feat |
新功能 | 增加 Minor 版本 |
fix |
修复 Bug | 增加 Patch 版本 |
docs |
仅文档变更 | 无 |
style |
代码格式(不影响运行) | 无 |
refactor |
重构(不是新功能也不是修 Bug) | 无 |
perf |
性能优化 | 无 |
test |
添加或修改测试 | 无 |
chore |
构建过程、辅助工具变动 | 无 |
build |
影响构建系统或外部依赖 | 无 |
revert |
回退之前的提交 | 无 |
示例:
单行提交
# 新功能
git commit -m "feat: 添加用户登录功能"
# 指定模块
git commit -m "feat: 添加 JWT 令牌刷新机制"
# 修复 Bug
git commit -m "fix: 修复密码重置时邮箱大小写敏感问题"
# 文档
git commit -m "docs: 更新 API 文档中的错误示例"
# 不写正文的小改动
git commit -m "chore: 更新 .gitignore 文件"
多行提交
git commit -m "feat: 添加用户导出功能
支持导出为 CSV 和 Excel 格式。
通过新增加的 ExportService 实现。
Closes #123"