commit规范

介绍

git 提交 commit 需要遵循一定的规范。前端开发,有eslint , stylelint 这种解决方案,当然也有commitlint

常用类型

::: tip build 构建

  • 更新构建脚本(如 MavenGradle 等)

  • 调整构建配置(如 Travis CIJenkins

  • 升级构建工具版本

  • 修改部署脚本

  • 更新打包方式

  • 调整编译选项 :::

::: tip chore 配置文件修改

  • 代码格式化和排版调整

  • 文档更新和补充

  • 增加日志输出

  • 重构代码结构

  • 配置文件的修改

  • 备份或删除文件

  • 代码格式化和排版调整

  • 更新依赖库版本

  • 添加或修改注释 :::

::: tip ci 持续集成

  • 更新持续集成配置文件(如 Travis CIJenkins 配置文件)

  • 调整构建脚本以适配持续集成系统

  • 更新测试脚本

  • 修改自动化部署脚本

  • 添加持续集成相关的说明文档 :::

::: tip docs 文档

  • 更新 README 文件

  • 修改项目文档

  • 添加或更新注释

  • 补充 API 文档

  • 修改帮助文档

  • 更新用户手册

  • 删除过期或无效的文档 :::

::: tip feat 新功能

  • 添加新功能或模块

  • 实现新的业务逻辑

  • 增加新的 API 端点

  • 引入新的库或依赖

  • 设计和开发新的用户界面

  • 添加新的配置选项

  • 增加新的功能测试 :::

::: tip fix 修复

  • 修复程序中的逻辑错误

  • 解决应用程序中的异常行为

  • 修复应用程序的漏洞或安全问题

  • 修复程序中可能导致崩溃或错误的代码部分

  • 修正数据处理或计算的错误 :::

::: tip perf 性能优化

  • 优化算法或数据结构

  • 减少代码复杂度或提高代码执行效率

  • 改进数据库查询性能

  • 优化内存管理和资源占用

  • 加速页面加载速度

  • 提升系统响应速度和性能 :::

::: tip refactor 重构

  • 重构代码以提高可读性和可维护性

  • 优化代码结构,减少重复代码

  • 改善代码性能或效率

  • 调整变量、函数、类命名

  • 清理无用的代码或注释

  • 优化代码布局和格式 :::

::: tip revert 回滚

  • 撤销之前引入的 bug 修复提交

  • 回退引入新功能的提交

  • 恢复错误的代码修改

  • 取消意外的更改

  • 退回不符合预期或错误的代码提交 :::

::: tip style 样式

  • 调整代码缩进和格式,以符合团队的统一规范

  • 规范化代码注释和文档的格式

  • 统一代码命名规范

  • 添加或删除空格、逗号等符号以提高代码可读性

  • 消除无用的代码空行或注释

  • 修正拼写错误或语法错误 :::

::: tip test 测试

  • 添加新的测试用例

  • 更新现有的测试用例,以适应代码变

  • 修复测试用例中的错误或问题

  • 优化测试用例的效率和覆盖率

  • 更新测试框架或工具 :::

# example (类型后跟随冒号+空格)
feat: add a new feature

参考

Last updated