柚子快報激活碼778899分享:Git 提交信息書寫規(guī)范
柚子快報激活碼778899分享:Git 提交信息書寫規(guī)范
commit message 書寫規(guī)范
規(guī)范的必要性提交規(guī)則使用方式1、安裝插件2、添加package.json文件配置3、自定義校驗格式【可選】:創(chuàng)建 .vcmrc 文件
Vscode 插件
規(guī)范的必要性
日常開發(fā)中,版本管理至關(guān)重要,清晰明了的提交信息方便自己快速了解每一個版本修改內(nèi)容。 假設(shè)有一個項目,只有你自己一個人開發(fā),那么你怎么寫都是無所謂的,但是如果是多人協(xié)作,特別是團隊表較大的時候,那么規(guī)范的提交信息就很重要了。良好的提交信息,便于后期方便排查與回退,過濾關(guān)鍵字便于迅速定位
提交規(guī)則
type:【必填】用于說明 commit 類別,可以是以下幾種:
feat:新功能fix:修復(fù)bugdocs:文檔變更style:代碼風格變更(不影響代碼運行的變動,如去掉空格、改變縮進、增刪分號)refactor:重構(gòu)(既不是新增功能,也不是修復(fù)bug的代碼變動)perf:性能優(yōu)化test:增加或修改測試代碼chore:構(gòu)建過程中或輔助工具的變動build:改變構(gòu)建流程,新增依賴庫、工具、構(gòu)造工具的或者外部依賴的改動,例如webpack,npmci:自動化流程配置修改、與 CI(持續(xù)集成服務(wù))有關(guān)的改動revert:回滾版本 scope:【選填】用于說明 commit 影響范圍,一般是修改的什么模塊或者是什么功能subject:【必填】用簡明的語言描述 commit 的目的,不要結(jié)束句點,因為Git會自動添加body::【選填】詳細描述,對于功能詳細的描述,可以使用多個段落進行詳細說明,解釋為什么做這個改動、使用了什么方式,有什么注意事項等等footer:【選填】添加一些額外的信息,包括2個字段: Breaking Changes(中斷性不兼容變動)、Closed Issues(關(guān)閉issue問題),如果改動關(guān)閉了某個issue,可以在這里指出issue的編號,如:Closes # 123
body 填寫要求: 1、要以動詞開頭,使用第一人稱現(xiàn)在時,比如change 2、第一個字母小寫 3、結(jié)尾不加句號(.)
示例:feat(用戶模塊):新增用戶登錄模塊
本次提交增加了用戶登錄頁面,保證使用系統(tǒng)的人員是可控的
Closes #123
使用方式
為了規(guī)范的執(zhí)行更好的落實,我們借助一款 Node 插件 validate-commit-msg 來檢查項目中 Commit message 是否規(guī)范。
1、安裝插件
npm install --save-dev validate-commit-msg
2、添加package.json文件配置
"config": {
"validate-commit-msg": {
"types": ["feat", "fix", "docs", "style", "refactor", "perf", "test", "chore", "build", "ci", "revert"],
"warnOnly": false,
"extends": []
}
}
3、自定義校驗格式【可選】:創(chuàng)建 .vcmrc 文件
{
"types": ["feat", "fix", "docs", "style", "refactor", "perf", "test", "chore", "build", "ci", "revert"],
"scope": {
"required": false,
"allowed": ["*"],
"validate": false,
"multiple": false
},
"warnOnFail": false,
"maxSubjectLength": 100,
"subjectPattern": ".+",
"subjectPatternErrorMsg": "subject does not match subject pattern!",
"helpMessage": "",
"autoFix": false
}
Vscode 插件
1、Vscode 插件市場搜索 git-commit-plugin 并且進行安裝 2、安裝完之后可以使用組合鍵 Command +Shift + P 呼出 指令行,并鍵入指令 show git commit template ,或者點擊 git 插件欄上的小圖標喚醒插件界面
3、根據(jù)自己當前提交所要表達的意義,選擇對應(yīng)的 type 類型去編寫 commit 信息。
柚子快報激活碼778899分享:Git 提交信息書寫規(guī)范
文章來源
本文內(nèi)容根據(jù)網(wǎng)絡(luò)資料整理,出于傳遞更多信息之目的,不代表金鑰匙跨境贊同其觀點和立場。
轉(zhuǎn)載請注明,如有侵權(quán),聯(lián)系刪除。