自古至今,无规矩不成方圆。

Git提交也有其规范,业内做的比较好的,比较具有参考价值的就是Angular的提交。

Angular提交规范:

<type>(<scope>): <subject> #header
// 空一行
<body>
// 空一行
<footer>

格式讲解

Header

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

总的来说,关键就是header这部分,至于<body>和<footer>可省略

例如:

feat:新增财务报表

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,建议是不要。

 

scope

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

subject

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

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

反面示例1:

不要像如下这样提交,显得可笑(反面示例,以示警戒)

上面就是一部门功能,按照angular这种提交规范,应该要这样:

feat:完成部门管理功能

当然了,这样提交信息是叫完成部门管理功能,肯定是要包含上述的什么分页,新增,修改,删除等等的。没有必要这么写一大堆罗里吧嗦的。

反面示例2:

这个提交信息让人觉得太泛。你提交的信息是财务,财务有很多功能啊,比如财务报表,其中报表又分月报表和日报表,报表中还有支出报表和收入报表等等。

上述的提交缺点是信息不明确,太泛。

反面示例3:

删除文件,同样也是信息不明确,不过这个人犯的错误是实际删除了一个Java类,当然了,Java类也是一个文件,不过这里让人很疑惑,你到底删除了几个类啊或者是其他文件呢?你光就一个提交信息,说删除文件,鬼知道你删除了多少文件。

既然是删除文件,你可以这样提交信息:

del:删除cn.test包下的Test.Java

这样与上面对比,岂不是简洁的多。

当然了,实际中,也不一定要采用Angular这种,但是你可以借鉴它的,然后自己那边再根据实际情况变动。

提交规范在于以后维护方面是非常有利的,先不说远的,近的话,使用Git时,合并代码通常会有冲突,有些突发意外,比如另外的人不小心将你的代码覆盖了,而且这个功能已经是很久之前的了,那怎么办呢?通常情况,本地有备份固然好,但是估计也没有那个人会将自己每次提交,都本地保存一份,因为那样显得效率低下和根据项目的周期和需求,项目越来越大,这样的话,本地备份的包也会越来越多。没有人会选择这种方式。最后的方式就是版本回退,当然了,前提是你提交信息必须简洁明了,不然的话像上面的反面例子,鬼知道是哪个。

另外关于什么时候,提交,尽可能是完成一个新的功能或者是优化某个功能,解决某个bug等等就提交。但是这里有个前提就是,你本地必须测试没有问题,否则那样等于做无用工。

希望这篇文章能给大家带来帮助。

关于Git提交规范的更多相关文章

  1. 利用shell脚本生成CHANGELOG.md(包含git提交规范)

    前言 我们经常看到github上面有很多CHANGELOG.MD包含版本的更新信息,如果我们的git提交能遵循一定的规范,那么使用gitlog就能很方便的生成它 生成结果  shell脚本 http ...

  2. git 提交规范

    git 提交规范 前言 无规矩不成方圆,编程也一样. 如果你有一个项目,从始至终都是自己写,那么你想怎么写都可以,没有人可以干预你.可是如果在团队协作中,大家都张扬个性,那么代码将会是一团糟,好好的项 ...

  3. 项目工程化之git提交规范以及 CHANGELOG生成

    事先声明,本文是参考了其他大神的博客之后自己尝试的记录,具体可以参考如下 链接 先说说git 提交规范把,这里基本都是这个工具 cz-customizable 1,安装 npm install cz- ...

  4. 开发中的你的Git提交规范吗?

    1. 前言 目前大部分公司都在使用Git作为版本控制,每个程序员每天都要进行代码的提交.很多开发者也包括我自己,有时候赶时间或者图省事,就这么提交: git commit -m "修改bug ...

  5. 前端规范之Git提交规范(Commitizen)

    代码规范是软件开发领域经久不衰的话题,几乎所有工程师在开发过程中都会遇到或思考过这一问题.而随着前端应用的大型化和复杂化,越来越多的前端团队也开始重视代码规范.同样,前段时间,笔者所在的团队也开展了一 ...

  6. 老鸟都应该注意的git 提交规范

    不知道大家有没有看过自己项目的git 提交信息-----我看过好多次 ,不忍直视  然后提醒一起的小伙伴 :大家规范点 信息要详细, 过段时间再看下 ,还是一样. 相信很多猿都有这样的感受,对于垃圾的 ...

  7. 你可能会忽略的 Git 提交规范

    一.为什么需要规范? 无规矩不成方圆,编程也一样. 如果你有一个项目,从始至终都是自己写,那么你想怎么写都可以,没有人可以干预你.可是如果在团队协作中,大家都张扬个性,那么代码将会是一团糟,好好的项目 ...

  8. Git提交规范

    Commit message 的格式 每次提交,Commit message 都包括三个部分:Header,Body 和 Footer. <type>(<scope>): &l ...

  9. Git提交代码规范 而且规范的Git提交历史,还可以直接生成项目发版的CHANGELOG(semantic-release)

    Git提交代码规范 - 木之子梦之蝶 - 博客园 https://www.cnblogs.com/liumengdie/p/7885210.html Commit message 的格式 Git 每次 ...

随机推荐

  1. JSON 转 VO

    需求 将获取的json数据直接转为vo 解决 利用net.sf.json.JSONObject的toBean() 确保json中的key值和vo中的字段名称一致 JSONObject jsonObje ...

  2. python--boto3 之 与dynamoDB 的基本交互,表的备份与恢复

    最近因工作需要,研究了一下boto3中dynamoDB部分,略有心得,在此总结一下. 首先是boto3的安装,在装有python和pip的机器上,运行 sudo pip install boto3 官 ...

  3. pom文件解析

    Maven的依赖是使用Maven坐标来定位的,而Maven坐标主要由GAV(groupId, artifactId, version)构成.因此,使用任何一个依赖之间,你都需要知道它的Maven坐标. ...

  4. java 阿里云接口实现发送短信验证码

    此刻自己做的小项目中,需要用到手机发送短信验证码实现注册功能,于是就去阿里云注册了账号,并实现随机发送验证码的功能 第一步:在阿里云官网登录注册   已有支付宝或淘宝的账号可以直接登录,最后需要实名认 ...

  5. CSS3动画功能

    1.transition功能 transition属性的使用方法:transition:property duration timing-function; 其中property表示对哪个属性进行平滑 ...

  6. python anaconda 安装 环境变量 升级 以及特殊库安装

    Anaconda 是一个旗舰版的python安装包, 因为普通的python没有库, 如果需要安装一些重要的库, 要经常一个一个下载,会非常麻烦. 所以这个一个集成的, 可以手动批量升级的软件. 而且 ...

  7. css的字体样式怎么写

    为保证字体的正常加载 sans-serif不能丢 font-family:'MicrosoftYahei','微软雅黑',Arial,'宋体',sans-serif;

  8. 关于pom版本提交不成功的问题

    今天碰到个问题:我在原来的一个pom项目的client服务里面修改了一个java类,但是没有升级版本.然后再预发环境更新后,从显示的日志来看,仍然是我修改前的版本. 这就奇怪了,看了svn确实已经提交 ...

  9. 使用SDL2出现 “error LNK2019: 无法解析的外部符号 _SDL_main,该符号在函数 _main 中被引用” 时的可能错误记录

    这几天在使用SDL2,之前一直都没有错,直到上午把项目搬了个地方.结果一直出现 “error LNK2019: 无法解析的外部符号 _SDL_main,该符号在函数 _main 中被引用” . 看了网 ...

  10. nodejs + redis/mysql 连接池问题

    nodejs + redis/mysql 连接池问题 需不需要连接池 连接池的作用主要是较少每次临时建立连接所带来的开销.初步一看,nodejs运行单线程上,它不能同时使用多个连接,乍一看是不需要连接 ...