✅ 标准 Git Commit 模板格式指南
格式模板
<type>(<scope>): <subject>
<body> ← 可选,详细说明做了什么,为啥这么做
📌 常见的 <type>
类型说明
类型 | 说明 |
---|
feat | 新增功能(feature) |
fix | 修复 bug |
docs | 修改文档、注释等 |
style | 格式修改(不影响功能,如空格) |
refactor | 代码重构(非功能/性能修改) |
perf | 性能优化 |
test | 新增或修改测试代码 |
chore | 构建过程、工具、依赖等变更 |
revert | 回滚某次提交 |
ci | CI配置相关(如 GitLab CI) |
build | 打包构建相关 |
📦 示例 Commit 内容
feat(detection): 增加垃圾投放检测模块
fix(camera): 修复摄像头启动偶发卡死的问题
docs(readme): 更新项目使用说明和部署文档
style(code): 统一缩进为4空格,去除多余空行
refactor(ai-core): 拆分主函数结构,优化逻辑流程
test(tracker): 增加目标跟踪器的单元测试用例
📘 推荐约定
subject
不超过 50 字- 使用英文开头(尽量)或中文也行,但风格统一
- 不要以大写字母开头,不加句号
- 提交多个类型,可分多条
commit