跳到主要内容

Git 代码提交与分支命名规范

· 阅读需 2 分钟
酒辞.

Git 代码提交规范

commit message = subject + :+ 空格 + message 主体

例如: git commit -m "feat:增加用户注册功能"

常见的 subject 种类以及含义如下:

  1. feat: 新功能(feature)
    • 用于提交新功能
    • 例如:feat: 增加用户注册功能
  2. fix: 修复 bug
    • 用于提交 bug 修复
    • 例如:fix: 修复登录页面崩溃的问题
  3. docs: 文档变更
    • 用于提交仅文档相关的修改
    • 例如:docs: 更新README文件
  4. style: 代码风格变动(不影响代码逻辑)
    • 用于提交仅格式化、标点符号、空白等不影响代码运行的变更
    • 例如:style: 删除多余的空行
  5. refactor: 代码重构(既不是新增功能也不是修复bug的代码更改)
    • 用于提交代码重构
    • 例如:refactor: 重构用户验证逻辑
  6. perf: 性能优化
    • 用于提交提升性能的代码修改
    • 例如:perf: 优化图片加载速度
  7. test: 添加或修改测试
    • 用于提交测试相关的内容
    • 例如:test: 增加用户模块的单元测试
  8. chore: 杂项(构建过程或辅助工具的变动)
    • 用于提交构建过程、辅助工具等相关的内容修改
    • 例如:chore: 更新依赖库
  9. build: 构建系统或外部依赖项的变更
    • 用于提交影响构建系统的更改
    • 例如:build: 升级webpack到版本5
  10. ci: 持续集成配置的变更
    • 用于提交CI配置文件和脚本的修改
    • 例如:ci: 修改GitHub Actions配置文件
  11. revert: 回滚
    • 用于提交回滚之前的提交
    • 例如:revert: 回滚feat: 增加用户注册功能

Git 分支命名规范

常见的分支种类以及含义如下:

  1. master/main: 主分支,用于存放稳定的代码
  2. develop: 开发分支,用于存放最新的开发代码
  3. feature/feat: 功能分支,用于开发新功能
  4. bugfix/fix: 修复分支,用于修复 bug
  5. hotfix: 紧急修复分支,用于修复生产紧急 bug
  6. release: 发布分支,用于准备发布新版本
  7. support: 支持分支,用于维护旧版本
  8. test: 测试分支,用于测试代码

补充:

  • git branch -d dev:删除本地dev分支

  • git push origin --delete dev:删除远程dev分支

Loading Comments...