Git 代碼規(guī)范

Git 每次提交代碼，都是需要寫Commit message（提交說明）。一般Commit message 的格式包含三個部分：

Header -----必填

????type ---必需

????scope --- 可選

????subject ---必需

Body ---- 可省略

Footer ---- 可省略

提交遵循原子性提交原則：每次盡可能最小量提交，僅包含一個不可分割的基本特性、問題修復(fù)或者優(yōu)化提升，以便于code review / rollback / modification

在實(shí)際提交實(shí)踐的過程中，大部分時候僅包含了Herder，提交最簡、最重要的消息，即 ：

Header?= 【Type】+【Subject】

Type

feat：提交新功能

fix：修復(fù)了bug

docs：只修改了文檔

style：調(diào)整代碼格式，未修改代碼邏輯（比如修改空格、格式化、缺少分號等）

refactor：代碼重構(gòu)，既沒修復(fù)bug也沒有添加新功能

perf：性能優(yōu)化，提高性能的代碼更改

test：添加或修改代碼測試

chore：對構(gòu)建流程或輔助工具和依賴庫（如文檔生成等）的更改

Subject

標(biāo)題是對變更的簡明描述，三個注意點(diǎn)：

????使用祈使句，現(xiàn)在時態(tài)

????不要大寫首字母

????結(jié)尾不要使用句號

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?正文是對標(biāo)題的補(bǔ)充，不是必須的，其包含更詳細(xì)的信息，如代碼修改的動機(jī)、方式、與修改前的代碼對比等等。

Footer?注腳，通常是BREAKING CHANGE 或修復(fù)bug的鏈接。