柚子快報邀請碼778899分享：代碼規(guī)范 Git 提交規(guī)范
柚子快報邀請碼778899分享：代碼規(guī)范 Git 提交規(guī)范
Git 提交規(guī)范
先看一個vue官網(wǎng)github上的提交記錄-都是有提交規(guī)范的
點我可以去瞧瞧嘍，記得回來繼續(xù)往下看?
1. 提交類型（Type）
提交信息的開頭應(yīng)包含提交類型，這有助于快速理解提交的目的。常見的提交類型包括：
feat: 新功能fix: 修復(fù)問題docs: 文檔更新style: 代碼格式（不影響代碼運行的變動）refactor: 代碼重構(gòu)（既不是修復(fù)bug也不是添加新功能的代碼更改）perf: 性能優(yōu)化test: 添加測試或更新測試build: 構(gòu)建系統(tǒng)或外部依賴項的更改（如webpack，npm）ci: 持續(xù)集成相關(guān)的變動chore: 其他不修改 src 或測試文件的更改revert: 回滾某次提交
2. 提交信息格式
每次提交信息應(yīng)按照以下格式：
2.1
type: 提交類型 scope: 影響范圍（可選），例如某個模塊或文件夾 subject: 簡短的描述，不能超過50個字符，以動詞開頭，首字母小寫，結(jié)尾不加句號 示例：
feat(auth): 添加用戶認(rèn)證功能
2.2
（可選）主體部分可以詳細描述提交的內(nèi)容和目的，包括為什么要進行這次更改以及其背景信息。每行應(yīng)不超過72個字符。
示例：
feat(auth): 添加用戶認(rèn)證功能
新增了一個用戶認(rèn)證模塊，用于處理登錄、注冊和密碼恢復(fù)流程。
這是為了保護用戶數(shù)據(jù)并提供個性化體驗所必需的功能。
2.3
用于添加與提交有關(guān)的任何元數(shù)據(jù)，如關(guān)聯(lián)的任務(wù)號、關(guān)閉的issues、重大變更的聲明等。
示例：
fix(auth): 修復(fù)登錄問題
修復(fù)了一個導(dǎo)致用戶無法使用有效憑據(jù)登錄的bug。
問題是由一個錯誤的驗證函數(shù)引起的。
Closes #42
3. 提交規(guī)范示例
新增功能feat(cart): 添加商品數(shù)量驗證
新增了商品數(shù)量驗證，確保加入購物車的商品數(shù)量不會超過庫存。
這可以防止用戶將超過庫存的商品加入購物車。
修復(fù)問題fix(button): 修正移動端按鈕對齊問題
調(diào)整了CSS以修正小屏幕尺寸下按鈕對齊不正確的問題。
這確保了在各種設(shè)備上的一致用戶體驗。
Closes #108
文檔更新docs(README): 更新安裝說明
更新了README中的安裝部分，包含了設(shè)置最新版本中引入的新依賴項的步驟。
代碼格式style(header): 格式化頭部組件代碼
對頭部組件的代碼進行了格式化，以提高可讀性。
沒有功能上的更改。
代碼重構(gòu)refactor(user-service): 重構(gòu)用戶數(shù)據(jù)獲取邏輯
使用async/await語法重構(gòu)了用戶服務(wù)，以提高可讀性和錯誤處理能力。
功能上沒有變化。
4. 最佳實踐
確保每次提交只包含一個明確的變更。在提交前自測代碼，確保其功能完整且無誤。參考提交歷史，確保提交信息的一致性。 使用規(guī)范的提交信息，可以提高代碼庫的可讀性和可維護性，為團隊協(xié)作和項目管理帶來顯著的優(yōu)勢。
柚子快報邀請碼778899分享：代碼規(guī)范 Git 提交規(guī)范
推薦鏈接
本文內(nèi)容根據(jù)網(wǎng)絡(luò)資料整理，出于傳遞更多信息之目的，不代表金鑰匙跨境贊同其觀點和立場。
轉(zhuǎn)載請注明，如有侵權(quán)，聯(lián)系刪除。
Konga非洲精選行
