| name | git-commit-guide |
| description | Git 提交规范(Conventional Commits) |
| version | 1.0.0 |
| category | collaboration |
| triggers | ["git commit","提交规范","conventional commits","commit message","git 规范"] |
| scriptPath | check-git.sh |
| scriptType | bash |
| autoExecute | true |
| scriptTimeout | 5 |
Git 提交规范技能包
遵循 Conventional Commits 规范,提升团队协作质量和代码可维护性。
提交消息格式
<type>(<scope>): <subject>
<body>
<footer>
基本格式
<类型>[可选作用域]: <描述>
示例:
feat(api): 添加用户认证接口
fix(database): 修复连接池泄漏问题
docs(readme): 更新安装说明
提交类型(Type)
| 类型 | 说明 | 示例 |
|---|
| feat | 新功能 | feat(user): 添加用户注册功能 |
| fix | Bug 修复 | fix(login): 修复密码验证错误 |
| docs | 文档变更 | docs(api): 更新 API 文档 |
| style | 代码格式(不影响逻辑) | style: 统一代码缩进 |
| refactor | 重构(不是新功能或修复) | refactor(auth): 优化认证逻辑 |
| perf | 性能优化 | perf(query): 优化数据库查询 |
| test | 测试相关 | test(user): 添加用户模块单元测试 |
| build | 构建系统或外部依赖 | build: 升级 Spring Boot 到 3.0 |
| ci | CI 配置文件和脚本 | ci: 添加 GitHub Actions 配置 |
| chore | 其他不修改源代码的变更 | chore: 更新 .gitignore |
| revert | 回滚之前的提交 | revert: 回滚 feat(api): xxx |
作用域(Scope)
作用域表示影响的模块或组件,可选但建议添加。
常见作用域示例:
user - 用户模块
auth - 认证模块
api - API 接口
database - 数据库
config - 配置
ui - 用户界面
描述(Subject)