git提交记录规范
Git commit 规范
Git commit规范是一种约定俗成的方法,用于规范化Git提交消息的格式和内容,以帮助团队更容易理解和维护代码库的历史记录。以下是一些常见的Git commit规范的建议,通常遵循"Conventional Commits"规范:
1.提交消息结构:
每个提交消息应该分为三个部分:类型、可选的作用域和描述。
每个部分之间用冒号分隔,并用空格进行分隔。
例如:
feat(user-auth): add user registration functionality
2.类型(Type):
- 类型描述了提交的性质,通常是以下之一:
- feat: 添加新功能
- fix: 修复错误
- docs: 文档变更
- style: 代码格式、样式的调整,不涉及功能更改
- refactor: 重构代码,既不修复错误也不添加新功能
- perf: 优化性能
- test: 添加或修改测试
- chore: 更新构建过程、工具、库等非业务相关内容
3.作用域(Scope):可选
- 作用域描述了提交的影响范围,通常是一个模块、文件或组件的名称。
4.描述(Description):
- 描述是对提交的简要描述,应该清晰、简洁,以描述所做的更改。
5.示例:
- 好的提交消息示例:
feat(login): add user login functionality
fix(order-processing): handle edge case in order processing
docs(readme): update installation instructions

浙公网安备 33010602011771号