MorJS Git Commit概述

約定式提交規(guī)范是一種基于提交信息的輕量級(jí)約定。 它提供了一組簡(jiǎn)單規(guī)則來(lái)創(chuàng)建清晰的提交歷史； 這更有利于編寫(xiě)自動(dòng)化工具。 通過(guò)在提交信息中描述功能、修復(fù)和破壞性變更， 使這種慣例與 SemVer 相互對(duì)應(yīng)。

提交說(shuō)明的結(jié)構(gòu)如下所示：

原文：

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

譯文：

<類(lèi)型>[可選 范圍]: <描述>

[可選 正文]

[可選 腳注]

提交說(shuō)明包含了下面的結(jié)構(gòu)化元素，以向類(lèi)庫(kù)使用者表明其意圖：

1. fix: 類(lèi)型 為 fix 的提交表示在代碼庫(kù)中修復(fù)了一個(gè) bug（這和語(yǔ)義化版本中的 PATCH 相對(duì)應(yīng)）。
2. feat: 類(lèi)型 為 feat 的提交表示在代碼庫(kù)中新增了一個(gè)功能（這和語(yǔ)義化版本中的 MINOR 相對(duì)應(yīng)）。
3. BREAKING CHANGE: 在腳注中包含 BREAKING CHANGE: 或 <類(lèi)型>(范圍) 后面有一個(gè) ! 的提交，表示引入了破壞性 API 變更（這和語(yǔ)義化版本中的 MAJOR 相對(duì)應(yīng)）。破壞性變更可以是任意 類(lèi)型 提交的一部分。
4. 除 fix: 和 feat: 之外，也可以使用其它提交 類(lèi)型 ，例如 @commitlint/config-conventional（基于 Angular 約定）中推薦的 build:、chore:、ci:、docs:、style:、refactor:、perf:、test: 等。
5. 腳注中除了 BREAKING CHANGE: <description> ，其它條目應(yīng)該采用類(lèi)似 git trailer format 這樣的慣例。

可以為提交類(lèi)型添加一個(gè)圍在圓括號(hào)內(nèi)的范圍，以為其提供額外的上下文信息。例如 feat(parser): adds ability to parse arrays.。