提交格式
<type>(<scope>): <subject>
<body>
一、Type(必填)
类型 | 说明 |
---|---|
feat | 新增功能(Feature) |
fix | 修复 Bug |
docs | 文档更新(如 README、注释等) |
style | 代码样式调整(如空格、格式化,不改变逻辑) |
refactor | 代码重构(既不修复 Bug 也不新增功能) |
perf | 性能优化 |
test | 增加或修改测试用例 |
chore | 构建或辅助工具变更(如依赖更新、配置文件修改) |
ci | CI/CD 相关变更(如 GitHub Actions、Jenkins) |
revert | 回滚之前的提交 |
build | 构建系统或外部依赖变更(如 webpack、npm) |
二、Scope(必填)
说明修改影响的范围,一般是模块名称或者文件名称
- feat(user): add profile page
- fix(api): handle null response
三、Subject(必填)
简短描述修改的内容
使用祈使语气(如 “add” 而不是 “added” 或 “adds”)。
正确:fix: handle empty array in request
错误:fixed the bug where request fails
四、Body(选填)
- 详细说明提交的动机和变更内容(每行不超过 72 字符)。
- 可以列出关键点或解决的问题。
refactor(database): migrate to PostgreSQL
- Replace MongoDB with PostgreSQL for transactions
- Update ORM configuration
- Add migration scripts