文章

Git 约定式提交规范

Git 提交信息的规范化

Git 约定式提交规范

参考资料:Git 约定式提交规范

Git 约定式提交规范

约定式提交(Conventional Commits)是一种为 Git 提交信息制定格式规范的方法。它通过统一的前缀(如 feat:, fix:, docs: 等)描述每次提交的类型和内容,便于自动生成变更日志、版本管理和持续集成。常见格式为:

1
<type>: <描述>

例如:

1
2
feat: 新增用户注册功能
fix: 修复登录时的密码校验 bug

这种规范有助于团队协作,提高代码管理的规范性和自动化程度。

常见的约定式提交(Conventional Commits)type 及其含义如下:

  • feat:新增功能
    • 用于引入新的功能模块或特性。
  • fix:修复 bug
    • 用于修复问题或缺陷。
  • docs:文档变更
    • 仅修改了文档内容,如 README、注释等。
  • style:代码格式
    • 不影响代码逻辑的修改,如空格、缩进、格式化等。
  • refactor:代码重构
    • 代码结构调整,未新增功能或修复 bug。
  • test:测试相关
    • 新增或修改测试代码,不影响业务逻辑。
  • chore:构建过程或辅助工具变动
    • 例如构建脚本、依赖管理等的变更。
  • perf:性能优化
    • 提升性能的相关修改。
  • build:构建系统或外部依赖变更
    • 如 webpack、npm 等构建工具相关的变更。
  • ci:持续集成相关变更
    • 如 CI 配置文件、流水线脚本等的修改。

这些 type 使提交记录更清晰、易于自动化处理。

使用示例:

1
2
3
git add .
git commit -m "feat: 新增用户注册功能"
git push origin main
本文由作者按照 CC BY 4.0 进行授权