Git 代碼規(guī)范
Git 每次提交代碼,都是需要寫Commit message(提交說明)火本。一般Commit message 的格式包含三個(gè)部分:
Header -----必填
????type ---必需
????scope --- 可選
????subject ---必需
Body ---- 可省略
Footer ---- 可省略
提交遵循原子性提交原則:每次盡可能最小量提交危队,僅包含一個(gè)不可分割的基本特性、問題修復(fù)或者優(yōu)化提升钙畔,以便于code review / rollback / modification
在實(shí)際提交實(shí)踐的過程中茫陆,大部分時(shí)候僅包含了Herder,提交最簡擎析、最重要的消息簿盅,即 :
Header?= 【Type】+【Subject】
Type
feat:提交新功能
fix:修復(fù)了bug
docs:只修改了文檔
style:調(diào)整代碼格式,未修改代碼邏輯(比如修改空格揍魂、格式化桨醋、缺少分號(hào)等)
refactor:代碼重構(gòu),既沒修復(fù)bug也沒有添加新功能
perf:性能優(yōu)化愉烙,提高性能的代碼更改
test:添加或修改代碼測試
chore:對(duì)構(gòu)建流程或輔助工具和依賴庫(如文檔生成等)的更改
Subject
標(biāo)題是對(duì)變更的簡明描述讨盒,三個(gè)注意點(diǎn):
????使用祈使句,現(xiàn)在時(shí)態(tài)
????不要大寫首字母
????結(jié)尾不要使用句號(hào)
Example
chore: add Oyster build script
docs: explain hat wobble
feat: add beta sequence
fix: remove broken confirmation message
refactor: share logic between 4d3d3d3 and flarhgunnstow
style: convert tabs to spaces
test: ensure Tayne retains clothing
Other
Body?正文是對(duì)標(biāo)題的補(bǔ)充步责,不是必須的返顺,其包含更詳細(xì)的信息,如代碼修改的動(dòng)機(jī)蔓肯、方式遂鹊、與修改前的代碼對(duì)比等等。
Footer?注腳蔗包,通常是BREAKING CHANGE 或修復(fù)bug的鏈接秉扑。