吴呈的 Commit 规则

一个 git 仓库由哪些组成?

一个代码仓库存在了多个组成部分,其中包含了源代码、文档、测试、脚本等等。所以我们可以将其分为以下几类:

  • 源代码
  • 文档
  • 测试
  • 脚本
  • 配置(纯文件)

Commit 的格式

为了能够更好的描述 commit 的相关信息,我使用了大多数开发者都使用的格式:

任务标签(范围): Title
Body

任务标签用于描述本次 commit 的类型,不同类型有不同含义。

范围用于描述本次 commit 变更文件所属的范围。该范围可以是仓库中的任意一个方向。

Title 则是用于概括当前变更的粗略介绍。

Body 这是介绍具体的变更内容。当变更较小,Title 已经能覆盖所有的变更时,Body 段可以省略。

接下来我们分别梳理各个部分下可能出现的任务。

源代码

遵循 Kiss 原则,我将源代码中的变更分为两种。一个为 feature,另一个为 fix.

其中 feature 用于源代码中有新增的功能时使用。

fix 则用于修改源代码时使用。

最后,这两个任务只能处理源代码的变更,而不能用于其他部分的变更。

文档

文档我只保留一个 doc 的任务标签,用于表示所有与文档相关的变更。其中包括新增文档,修改文档和删除文档。

测试

所有的测试相关变更,如新增测试,修改测试内容都可以使用 test 任务标签。

脚本

脚本内容同样使用一个标签 script 表示。任何与脚本相关的,如 ptyhon 脚本(python 源码不算),bash 脚本等等都适用该标签。

配置(纯文件)

纯文件配置项和文档,测试,脚本一样,使用一个标签 config 标识。纯文件配置可以是 JSON,Yaml,INI 和 TOML 等等。

一图流

任务标签组成部分描述
feature源代码新增一个新的功能。
fix源代码修改一个或多个源代码内容
doc文档描述文档相关的变更
test测试描述测试相关的变更
script脚本描述脚本相关的变更
config纯文件配置描述纯文件配置相关的变更