在使用 Git 進(jìn)行版本控制時(shí)，良好的提交信息可以幫助團(tuán)隊(duì)成員更好地理解每次提交的目的和影響。為了規(guī)范化提交信息，一些團(tuán)隊(duì)采用了特定的格式或約定，比如 Angular 團(tuán)隊(duì)提出的 Commit Message Conventions。這種規(guī)范有助于自動(dòng)化工具的使用，例如自動(dòng)生成變更日志。

以下是一些常見的提交類型及其含義，這些類型通常用于描述提交的主要目的：

• feat: 添加新功能（feature）
• fix: 修復(fù)錯(cuò)誤（bug fix）
• chore: 不修改 src 或 test 文件的更改，通常是更新構(gòu)建系統(tǒng)或外部依賴（如 gulp, npm 等）
• refactor: 重構(gòu)現(xiàn)有代碼，既不添加功能也不修復(fù)錯(cuò)誤
• docs: 文檔更新
• style: 不影響代碼運(yùn)行的改動(dòng)（如空格、格式化、刪除多余字符等）
• test: 增加缺失的測(cè)試用例或修正現(xiàn)有的測(cè)試用例
• perf: 性能優(yōu)化
• ci: 持續(xù)集成相關(guān)文件的更改
• revert: 回滾到之前的某個(gè)狀態(tài)
• build: 影響構(gòu)建系統(tǒng)的更改，例如改變編譯器配置或構(gòu)建腳本
• restruct: 重組項(xiàng)目結(jié)構(gòu)，這可能涉及到大量文件的移動(dòng)或重命名，但不一定涉及功能的變化

對(duì)于 restruct 類型，雖然它不是標(biāo)準(zhǔn)的 Commit Message Conventions 中的一部分，但是有些團(tuán)隊(duì)可能會(huì)采用這個(gè)標(biāo)簽來表示對(duì)項(xiàng)目結(jié)構(gòu)的重大調(diào)整。如果你的團(tuán)隊(duì)決定使用 restruct 作為提交類型，確保所有團(tuán)隊(duì)成員都了解其含義，并且在文檔中明確指出。

當(dāng)編寫提交信息時(shí)，推薦的格式如下：

<type>(optional scope): <description>Optional body with details and justification.Optional footer with issue references.

當(dāng)然可以，以下是幾個(gè)符合 Commit Message Conventions 標(biāo)準(zhǔn)的中文提交信息示例：

示例 1: 添加新功能

feat(用戶資料): 添加用戶頭像上傳功能增加了允許用戶上傳和更新個(gè)人資料圖片的功能。包括客戶端表單驗(yàn)證和服務(wù)器端圖像處理。關(guān)閉 #456

示例 2: 修復(fù)錯(cuò)誤

fix(認(rèn)證): 解決令牌過期問題修復(fù)了一個(gè)認(rèn)證令牌在過期后未能正確刷新的問題?，F(xiàn)在令牌刷新流程能夠正確處理失敗情況下的重試。修復(fù) #123

示例 3: 構(gòu)建任務(wù)

chore(構(gòu)建): 升級(jí) Webpack 至版本 5將項(xiàng)目的 Webpack 配置升級(jí)到了版本 5。這包括更新加載器和插件以兼容新的主要版本。本次更新未對(duì)功能進(jìn)行任何更改。

示例 4: 重構(gòu)代碼

refactor(服務(wù)): 重構(gòu)用戶服務(wù)模塊重構(gòu)了用戶服務(wù)模塊，提高了代碼的可讀性和維護(hù)性。沒有引入新的功能或修復(fù)已知的問題。改進(jìn) #789

示例 5: 更新文檔

docs(指南): 更新安裝指南更新了安裝指南，增加了關(guān)于環(huán)境變量配置的新章節(jié)，并修正了一些拼寫錯(cuò)誤。參考 #101

這些示例展示了如何使用不同的提交類型來描述具體的更改，并提供了簡(jiǎn)短的描述以及可選的詳細(xì)信息和問題引用。這樣可以使團(tuán)隊(duì)成員更容易理解和追蹤每次提交的目的和影響。

通過遵循這樣的規(guī)范，可以提高團(tuán)隊(duì)協(xié)作效率，確保每個(gè)成員都能快速準(zhǔn)確地理解每次提交的內(nèi)容。