Git Commit 规范指南
1. 功能开发类
feat(Feature)
表示新功能,用于提交新特性的代码。例如,当你开发了一个新的功能模块或添加了新的 API 时,可以使用这个前缀。 示例:
feat: 添加用户登录功能
fix(Fix)
表示修复,用于修复一个 bug。当你修正了代码中的某个错误或问题时,可以使用这个前缀。 示例:
fix: 修复无法正确显示用户头像的问题
2. 代码优化类
refactor(Refactor)
表示重构,用于重构代码时使用(即没有修复 bug 或添加新功能)。一般是指优化代码结构,提高代码的可读性或可维护性等。 示例:
refactor: 重构用户验证逻辑
style(Style)
表示代码格式,用于提交仅涉及代码格式调整的改动,例如代码缩进、空格、行距等,不会影响代码逻辑。 示例:
style: 统一代码缩进为 2 个空格
perf(Performance)
表示性能优化,用于提交提高性能的代码。 示例:
perf: 优化数据加载逻辑,减少页面渲染时间
3. 项目维护类
docs(Documentation)
表示文档,用于提交文档相关的改动,例如 README 文件的修改或补充。 示例:
docs: 更新安装指南
test(Test)
表示测试,用于新增或修改测试用例时使用。 示例:
test: 为用户登录功能添加单元测试
chore(Chore)
表示杂务,用于提交一些日常任务的代码,比如构建流程的调整、依赖包的升级、代码格式化等。这些提交通常不会影响生产代码或用户体验。 示例:
chore: 升级项目依赖到最新版本
4. 构建和部署类
build(Build)
表示构建,用于提交影响项目构建系统或外部依赖的更改(例如:Webpack、Grunt、Gulp 配置的修改)。 示例:
build: 修改打包配置以支持 Tree Shaking
ci(Continuous Integration)
表示持续集成,用于提交 CI(持续集成服务)配置文件和脚本的更改。 示例:
ci: 更新 GitHub Actions 配置文件
5. 特殊操作类
revert(Revert)
表示回滚,用于回滚之前的提交。通常跟随一个 commit 的哈希值。 示例:
revert: 回滚 3e42d69 的提交