zoukankan      html  css  js  c++  java
  • Git提交代码规范

    Commit message 的格式

    Git 每次提交代码,都要写 Commit message(提交说明),否则就不允许提交。

    用commit message最好是能有规范和工具的约束。

    每次提交,Commit message 都包括三个部分:header,body 和 footer。

    其中,header 是必需的,body 和 footer 可以省略。
    不管是哪一个部分,任何一行都不得超过72个字符(或100个字符)。这是为了避免自动换行影响美观。

    <type>(<scope>): <subject>
    <BLANK LINE>
    <body>
    <BLANK LINE>
    <footer> 

    Header

    Header部分只有一行,包括三个字段:type(必需)、scope(可选)和subject(必需)。

    type

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

    • feat:新功能(feature)

    • fix:修补bug

    • docs:文档(documentation)

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

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

    • test:增加测试

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

    如果type为featfix,则该 commit 将肯定出现在 Change log 之中。其他情况(docschorestylerefactortest)由你决定,要不要放入 Change log,建议是不要。

    scope

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

    例如在Angular,可以是$location$browser$compile$rootScopengHrefngClickngView等。

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

    subject

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

    其他注意事项:

    • 以动词开头,使用第一人称现在时,比如change,而不是changed或changes

    • 第一个字母小写

    • 结尾不加句号(.)

    Body

    Body 部分是对本次 commit 的详细描述,可以分成多行。下面是一个范例。

    More detailed explanatory text, if necessary.  Wrap it to 
    about 72 characters or so. 
    
    Further paragraphs come after blank lines.
    
    - Bullet points are okay, too
    - Use a hanging indent
    

      

    有两个注意点:

    • 使用第一人称现在时,比如使用change而不是changed或changes。

    • 永远别忘了第2行是空行

    • 应该说明代码变动的动机,以及与以前行为的对比。

    Footer

    Footer 部分只用于以下两种情况:

    不兼容变动

    如果当前代码与上一个版本不兼容,则 Footer 部分以BREAKING CHANGE开头,后面是对变动的描述、以及变动理由和迁移方法。

    BREAKING CHANGE: isolate scope bindings definition has changed.
    
        To migrate the code follow the example below:
    
        Before:
    
        scope: {
          myAttr: 'attribute',
        }
    
        After:
    
        scope: {
          myAttr: '@',
        }
    
        The removed `inject` wasn't generaly useful for directives so there should be no code using it.
    

      

    关闭 Issue

    如果当前 commit 针对某个issue,那么可以在 Footer 部分关闭这个 issue 。

    Closes #234
    

      

    Revert

    还有一种特殊情况,如果当前 commit 用于撤销以前的 commit,则必须以revert:开头,后面跟着被撤销 Commit 的 Header。

    revert: feat(pencil): add 'graphiteWidth' option
    
    This reverts commit 667ecc1654a317a13331b17617d973392f415f02.
    

      

    Body部分的格式是固定的,必须写成This reverts commit &lt;hash>.,

    其中的hash是被撤销 commit 的 SHA 标识符。

    如果当前 commit 与被撤销的 commit,在同一个发布(release)里面,

    那么它们都不会出现在 Change log 里面。

    如果两者在不同的发布,那么当前 commit,会出现在 Change log 的Reverts小标题下面。

     
    DO What You Want !
  • 相关阅读:
    nullptr和NULL
    tmux用于恢复远程屏幕
    如何改变git的默认路径
    scp拷贝文件
    C++头文件<bits/stdc++.h>
    MAME模拟器使用简单教程
    typescript接口扩展
    Typescript中的可索引接口 类类型接口
    typescript函数类型接口
    typescript静态属性 静态方法 抽象类 多态
  • 原文地址:https://www.cnblogs.com/liumengdie/p/7885210.html
Copyright © 2011-2022 走看看