git提交规范

当你希望从git提交历史中找出一段可以借鉴的代码的时候,你看到

这个时候的你,眉头一皱,就不得不深入阅读代码,才知道对原项目进行哪方面的修改。

当别人阅读你的提交历史时,他很可能是不知道具体代码细节的,但让整个Git提交历史的阅读变得非常轻松,让别人一眼就可以明白你提交代码的作用是什么。

  • 每次提交影响的具体范围?
  • 这个bug在哪次提交中被修复了?
  • 这个新功能是在哪次提交中增加的?
  • 修改是否向下兼容?
  • 是否回滚了代码?
  • 是否只是修改了文档、调整了代码格式?
  • 是否修改了测试、是否进行了重构?
  • 是否对代码进行了性能优化?

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
第一个字母小写
结尾不加句号(.)
posted @ 2021-04-01 10:06  倦梦还  阅读(167)  评论(0编辑  收藏  举报