Skip to content

Git 提交规范

在合到 master 中的节点具体的要求如下:

commit message 分为三部分。 第一部分:commit 的标题和描述; 第二部分:数据库结构变动 第三部分:刷数据

每两个部分之间必须要存在一行空行用来分隔

发布脚本和 Git Hook 会使用下面的正则表达式来判断是否符合要去,大家可以直接在这个链接中进行测试:

(?!\s)((?:.|\n)+)\n\n(数据库结构变动:\n(?!\s)(?:.|\n)*)(\n\n)(刷数据:\n(?:.|\n)+)

如果觉得难以理解也可以直接看下面的例子

例子

修复了订单导出金额不正确的问题

数据库结构变动:
无

刷数据:
无

↑ 正确。这是允许最短的的 commit 格式

订单异步导出

产品强迫我做的😢。
导出第一期,后面还有二期和三期。

数据库结构变动:

前面可以添加空行
增加了一张表
增加了一整表

刷数据:
前面也可以不添加空行
tools/tmp/launch_nuclear_bomb: 一个临时脚本,用来给用户刷 logo。
tools/celery_tasks/delete_database.py: 异步脚本,用来导出商户报价单。
这个脚本要非常小心地使用。

↑ 正确。message 中三个部分都可以写多行内容。

修复了订单导出金额不正确的问题

数据库结构变动:无

刷数据:无

↑ 错误。「数据库结构变动」和「刷数据」后面要换行

修复了订单导出金额不正确的问题

数据库结构变动:

刷数据:

↑ 错误。「数据库结构变动」和「刷数据」后面必须要有内容

    修复了订单导出金额不正确的问题

数据库结构变动:

刷数据:

↑ 错误。标题前面有空格