美文网首页
commit message format

commit message format

作者: 给我一炷香的时间 | 来源:发表于2017-02-27 14:40 被阅读26次

    一条提交信息由头部主体底部组成。头部类型范围主题组成。

    <类型>(<范围>): <主题>
    <空行>
    <主体>
    <空行>
    <底部>
    

    头部是必须要有的,但是头部中的范围是可选的。

    类型


    featfixperf,这三种类型会出现在changelog中,此外包含breaking change的提交也会出现在changelog中。

    除了上面三种类型,还可以自己决定一些和changelog不相关的类型,如:docschorestylerefactortest等等。

    Revert

    如果一个提交返回到了以前的提交,那么这个提交应该由revert:开头,后面跟以前那个提交的头部,主体应该写作This reverts commit <hash>.

    范围


    范围描述了一个提交改变的地方,如$location$browser$compile等等。

    主题


    主题是一个对此次提交的简短的描述,遵循以下规则:

    • 只包含必要的描述,使用现在时态("change" not "changed" nor "changes")。
    • 第一个字母不要大写
    • 末尾不要有点号

    主体


    同样遵循主题中描述的第一条规则,并且还应该包含此次改变的动机和上一次行为的对比。

    底部


    底部可以包含breaking change和本次关闭的issues

    breaking change应该由BREAKING CHANGE:开头,后接一个空格或者两个换行。
    例如:

    feat($location): 主题
    
    主体内容
    
    BREAKING CHANGE: 描述bc
    
    关闭 #213
    

    commitizen


    commitizen是一个方便按格式填写提交信息的工具。

    安装

    npm install -g commitizen
    
    # 如果还没有安装任何`commitizen adapter`的话,则需要运行下面的命令来安装适配器
    commitizen init cz-conventional-changelog --save-dev
    

    安装以后使用git cz代替git commit

    完结,撒花!!!

    相关文章

      网友评论

          本文标题:commit message format

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