
git提交规范
本文最后更新于 2024-06-14,文章内容可能已经过时,请注意发布时间。
Git 提交信息规范有助于团队成员更好地理解提交的目的和内容,提高代码的可读性和可维护性。以下是一个建议的 Git 提交信息规范:
feat: 新功能(feature)
用于提交新功能。
例如:
feat: 增加用户注册功能
fix: 修复 bug
用于提交 bug 修复。
例如:
fix: 修复登录页面崩溃的问题
docs: 文档变更
用于提交仅文档相关的修改。
例如:
docs: 更新README文件
style: 代码风格变动(不影响代码逻辑)
用于提交仅格式化、标点符号、空白等不影响代码运行的变更。
例如:
style: 删除多余的空行
refactor: 代码重构(既不是新增功能也不是修复bug的代码更改)
用于提交代码重构。
例如:
refactor: 重构用户验证逻辑
perf: 性能优化
用于提交提升性能的代码修改。
例如:
perf: 优化图片加载速度
test: 添加或修改测试
用于提交测试相关的内容。
例如:
test: 增加用户模块的单元测试
chore: 杂项(构建过程或辅助工具的变动)
用于提交构建过程、辅助工具等相关的内容修改。
例如:
chore: 更新依赖库
build: 构建系统或外部依赖项的变更
用于提交影响构建系统的更改。
例如:
build: 升级webpack到版本5
ci: 持续集成配置的变更
用于提交CI配置文件和脚本的修改。
例如:
ci: 修改GitHub Actions配置文件
revert: 回滚
用于提交回滚之前的提交。
例如:
revert: 回滚feat: 增加用户注册功能
举例:
fix: 修正购物车中税收计算错误
遵循这个规范,可以使团队成员更容易理解提交的目的和内容,提高协作效率。同时,这也有助于生成更易于理解的版本发布说明。
- 感谢你赐予我前进的力量