git代码提交规范

提交日志规范

参考agular的代码提交规范, 分成两部分

1
2
3
<提交简要>

<详细描述>
  • 提交简要写成一行
  • 提交简要和详细描述中间有空行
  • 原则上一次只提交一个提交简要
  • 提交简要是下面三个部分组成, 写在一行:
1
<修改类型><修改范围>:<修改内容>
  • 简要提交的修改类型如下:
    • feat:功能变动(feature)
    • fix:修补bug, 建议写bug id以(!bug_id)或者bug的http连接
    • docs:文档(documentation)
    • style: 格式(不影响代码运行的变动)
    • refactor:重构(即不是新增功能,也不是修改bug的代码变动)
    • test:测试相关
    • chore:构建过程或辅助工具的变动
  • 简要提交的修改范围, 可选, 用小括号()包裹, 中间用英文逗号,分割, 具体写法暂不做规定
  • 修改内容: 一句话说清楚本次提交的内容
  • 简要提交的末尾, 可以用(#feature_id, #feature_id2)来标识相关的feature

  • 详细描述可选, 详细描述可分为多行, 每行用 + * 号加 空格 开始, 其实就是方便支持md语法

1
2
3
* 具体描述1
* 具体描述2
* 具体描述3
  • 例外
    如果代码是merge和revert, 展示不做约定, 使用原来的提交即可, 如果要加描述, 按前面的规范写日志, 和默认revert, merge日志用—————-分割
  • 例子如下:
    feat: (通用版,登录)增加通用版的登录接口

docs: 添加提交规范文档

test: 去掉部分重复的测试

fix: !bugId bug简要描述

* bug http连接
* 相关的影响