製作有效的提交訊息是經驗豐富的開發人員的標誌。擁抱傳統提交規範是建立提交訊息的燈塔。這不僅僅是一個指導方針;這是獲得與語義版本控制 (SemVer)協調一致的更清晰提交歷史記錄的方法。
傳統提交提供了一個輕量級但功能強大的框架來組織提交訊息。透過將變更分類為功能、修復和重大變更等不同類型,它為清晰度和一致性設定了黃金標準,並透過將變更分類為功能、修復和重大變更來與語義版本控制(SemVer) 保持一致。
進行提交時,請使用常規提交格式,通常遵循<type>: <description>
的模式。
提交訊息應遵循以下結構:
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
type
: 提交類型
scope
:括號內的程式碼庫部分的簡短描述,後面跟著冒號和空格
description
:程式碼變更的簡短描述
body
:提交的較長描述,提供有關更改的附加上下文。
說明後必須放置一個空白行。
footer
: 修復問題 #3 //範例
頁腳應僅包含有關更改的其他問題參考。
例子:
我為解決問題所做的承諾。
feat(homepage): Add carousel feature to showcase testimonials
Implemented a carousel component on the homepage
Added client testimonials section for improved user engagement
Fixes #12
更多範例:
壯舉:新增新的評級元件
修復:解決城市搜尋功能的問題
文件:使用新的貢獻指南更新自述文件
除了經典的fix
和feat
之外,我們還有一整套提交類型。這就像為你的披薩選擇配料一樣:
build
:與建置流程或工具相關的變更。
chore
:定期維護或管理任務。
ci
:持續整合設定的更新。
docs
:與文件相關的變更。
style
:不影響程式碼功能的變更(例如,格式設定)。
refactor
:程式碼修改而不改變其行為。
perf
:性能改進。
test
:新增或修改測試。
您可以使用這些類型根據提交的性質對提交進行分類。這有助於保持提交訊息的一致性,並有助於更好地組織專案歷史記錄中的變更。
有關常規提交的更多訊息,請存取常規提交規範。
原文出處:https://dev.to/phukon/how-i-write-commits-like-a-pro-340l