美文网首页
如何规范git提交

如何规范git提交

作者: xiaoer0128 | 来源:发表于2020-11-18 10:19 被阅读0次

    规范梳理

    初期我们在互联网上搜索了大量有关git commit规范的资料,但只有Angular规范是目前使用最广的写法,比较合理和系统化,并且有配套的工具(IDEA就有插件支持这种写法)。最后综合阿里巴巴高德地图相关部门已有的规范总结出了一套git commit规范。

    commit message格式

    ():

    type(必须)

    用于说明git commit的类别,只允许使用下面的标识。

    feat:新功能(feature)。

    fix/to:修复bug,可以是QA发现的BUG,也可以是研发自己发现的BUG。

    fix:产生diff并自动修复此问题。适合于一次提交直接修复问题

    to:只产生diff不自动修复此问题。适合于多次提交。最终修复问题提交时使用fix

    docs:文档(documentation)。

    style:格式(不影响代码运行的变动)。

    refactor:重构(即不是新增功能,也不是修改bug的代码变动)。

    perf:优化相关,比如提升性能、体验。

    test:增加测试。

    chore:构建过程或辅助工具的变动。

    revert:回滚到上一个版本。

    merge:代码合并。

    sync:同步主线或分支的Bug。

    scope(可选)

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

    例如在Angular,可以是location,browser,compile,compile,rootScope, ngHref,ngClick,ngView等。如果你的修改影响了不止一个scope,你可以使用*代替。

    subject(必须)

    subject是commit目的的简短描述,不超过50个字符。

    建议使用中文(感觉中国人用中文描述问题能更清楚一些)。

    结尾不加句号或其他标点符号。

    根据以上规范git commit message将是如下的格式:

    fix(DAO):用户查询缺少username属性 feat(Controller):用户查询接口开发

    相关文章

      网友评论

          本文标题:如何规范git提交

          本文链接:https://www.haomeiwen.com/subject/dofbyftx.html