zoukankan      html  css  js  c++  java
  • git commit的提交规范

    git commit的提交规范

           最近我才意识到git 提交时候 commit measage的重要性,之前都是大大咧咧地随意发挥,正到了要查找日志记录的时候,一脸懵逼!满屏的fix。。。我这写的都是啥啥啥

           原来现在大家都在遵循Angular规范,我也来学学。先看下git commit提交消息正确的打开方式

           

    Commit message 的作用

    1)提供更多的历史信息,方便快速浏览。

    2)可以过滤某些commit(比如文档改动),便于快速查找信息

    3)可以直接从commit生成Change log。

    4)其他优点:

    • 可读性好,清晰,不必深入看代码即可了解当前commit的作用。
    • 为 Code Reviewing做准备
    • 方便跟踪工程历史
    • 让其他的开发者在运行 git blame 的时候想跪谢
    • 提高项目的整体质量,提高个人工程素质

    Commit message 的格式

         每次提交,Commit message 都包括三个部分:header,body 和 footer。 其中,header 是必需的,body 和 footer 可以省略

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

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

    • feat:新功能(feature)
    • fix:修补bug
    • docs:文档(documentation)
    • style: 格式(不影响代码运行的变动)
    • refactor:重构(即不是新增功能,也不是修改bug的代码变动)
    • test:增加测试
    • chore:构建过程或辅助工具的变动

    如果type为feat和fix,则该 commit 将肯定出现在 Change log 之中。其他情况(docs、chore、style、refactor、test)由你决定,要不要放入 Change log,建议是不要。

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

         例如在Angular,可以是$location, $browser, $compile, $rootScope, ngHref, ngClick, ngView等。

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

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

         其他注意事项:

    • 以动词开头,使用第一人称现在时,比如change,而不是changed或changes
    • 第一个字母小写
    • 结尾不加句号(.)

     参考链接:

    https://www.jianshu.com/p/201bd81e7dc9?utm_source=oschina-app

     

  • 相关阅读:
    Crontab问题总结
    确定两个 Geometry 实例之间的关系
    Silverlight 多点触控(MultiTouch)
    在.NET中嵌入IronPython 交互
    Siebel集成OBI报表
    Silverlight XPS (PPT) Online
    Siebel Data Validation Manage 数据验证
    Siebel 附件清理
    Siebel 消息广播管理
    怎样创建一个.NET RIA Services Application (二)
  • 原文地址:https://www.cnblogs.com/hld123/p/13410659.html
Copyright © 2011-2022 走看看