git commit Angular规范

6,256 阅读1分钟

现在项目都使用git 进行代码的版本管理,使用 git commit -m "提交说明",进行提交,提交说明因尽量清晰明了,说明本次提交的目的。

推荐使用Angular 规范,这是目前使用最广的写法

message格式:每个提交的message均由header,body和footer组成。header具有特殊的格式,其中包括type(类型),scope(范围)和subject(主题):

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

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

type(类型)

  • build: 影响构建系统或外部依赖项的更改(示例范围:gulp,broccoli,npm)
  • ci: 对我们的CI配置文件和脚本的更改(示例范围:Circle,BrowserStack,SauceLabs)
  • docs: 仅文档更改
  • feat: 一项新的功能(feature)
  • fix: 一个bug的修复
  • perf: 代码优化,提高性能
  • refactor: 重构(既不修复bug也不增加新功能的代码更改)
  • style: 不会影响代码含义的更改(空格,格式,缺少分号等)
  • test: 添加缺失的测试或更正现有的测试

scope:用户说明commit的影响返回

subject:commit的简单描述,不超过50个字符 - 以动词开头,使用第一人称现在时,比如change,而不是changedchanges - 第一个字母小写 - 结尾不加句号(.

Body 对本次commit 的详细描述

参考:www.ruanyifeng.com/blog/2016/0…