git使用规范

最近总结了一套git使用规范,这也是我们前端组在用的一套规范,希望对小伙伴们有所帮助!

1.分支使用规范

  • 一个稳定master分支

  • 一个待发布的develop分支

  • 若干个正在开发的feature分支 (分支名称命名规则:feature/v+版本号)

  • 可以使用gitlab进行合并前的code review

  • 如遇到线上有一般的bug,可在develop上切换出hotFix分支进行bug修复,完成后合并到develop上,等下次版本一起发布

  • 如遇到线上有十分严重bug,应在master上切换出hotFix分支进行bug修复,并验证好了后随即合并到master上准备发布

  • 每次版本发布前或者发布后要给master增加tag并且和后台tag号保持一致(tag标签命名规则:release-x.x.x)

2.commit规范

  • 保证commit尽量只做一件事
  • 书写commit message言简意赅

    例:

      docs(/api):add missing '$timeout'
    
      fix($config):middleWhere by rules
    
    

    type

    用于说明 commit 的类别,使用下面标识。

    • feat:新功能(feature)
    • fix:修补 bug
    • docs:文档(documentation)
    • style:格式(不影响代码运行的变动)
    • build:改变构建流程,新增依赖库、工具等(例如 webpack 修改);
    • refactor:重构(即不是新增功能,也不是修改 bug 的代码变动)
    • test:增加测试
    • chore:构建过程或辅助工具的变动
    • perf:改善性能和体现的修改;
    • ci:自动化流程配置修改;
    • revert:回滚到上一个版本;

    scope(选填)

    scope 用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。

    可以是browser, $compile,View 等。

    如果你的修改影响了不止一个 scope,你可以使用*代替。

3.提测

本地测试好开发分支提测的时候合到develop分支

4.生产

上生产之后打tag tag命名规则以 release-V1.7.0 为例 V1.7.0以上线版本号为准

上生产之后删除原开发分支feature

你可能感兴趣的:(git使用规范)