git提交规范

作者: 虎虎 分类: dev工具 发布时间: 2023-06-25 17:11 阅读次数:1,123

大厂的Git代码规范

分支命名

  • master: 为主分支,也是用于部署生产环境的分支。需要确保master分支稳定性。
  • develop: 为开发环境分支,始终保持最新完成以及bug修复后的代码。
  • feature: 开发新功能时,以develop为基础创建feature分支。分支命名时以feature/开头,后面可以加上开发的功能模块,命名示例:feature/user_module、feature/cart_module。
  • test: 为测试环境分支,外部用户无法访问,专门给测试人员使用,版本相对稳定。
  • release: 为预上线分支(预发布分支),UAT测试阶段使用。一般由test或hotfix分支合并,不建议直接在release分支上直接修改代码。
  • hotfix: 线上出现紧急问题时,需要及时修复,以master分支为基线,创建hotfix分支。修复完成后,需要合并到master分支和develop分支。

分支与环境对应关系

分支 功能 环境 可访问
master 主分支,稳定版本 PRO
develop 开发分支,最新版本 DEV
feature 开发分支,实现新特性 -
test 测试分支,功能测试 FAT
release 预上线分支,发布新版本 UAT
hotfix 紧急修复分支,修复线上bug -

单次提交注意事项

  1. 提交问题必须为同一类别的。
  2. 提交问题不要超过3个。
  3. 提交的commit发现不符合规范,git commit --amend -m "新的提交信息" 或 git reset --hard HEAD 重新提交一次。

提交类型

  • feat: 新功能开发(新增功能模块或特性)
  • fix: 修复bug(解决已有功能的问题)
  • refactor: 代码重构(优化代码结构,不新增功能或修复bug)
  • docs: 修改文档(如README、注释等)
  • style: 代码风格调整(如格式化、缩进等,不影响功能)
  • test: 添加或修改测试用例
  • chore: 杂项任务(如更新.gitignore、构建脚本等)
  • perf: 性能优化(提升代码执行效率)
  • ci: CI/CD配置相关改动
  • build: 修改构建系统或依赖(如webpack配置)
  • revert: 回滚某个提交(撤销之前的更改)
不足之处望指正

发表评论

邮箱地址不会被公开。 必填项已用*标注

标签云