1. 程式人生 > 其它 >git commit 提交規範

git commit 提交規範

一直都不規範,希望以後開始可以規範點

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

(1)type

提交 commit 的型別,包括以下幾種

feat: 新功能
fix: 修復問題
docs: 修改文件
style: 修改程式碼格式,不影響程式碼邏輯
refactor: 重構程式碼,理論上不影響現有功能
perf: 提升效能
test: 增加修改測試用例
chore: 修改工具相關(包括但不限於文件、程式碼生成等)
deps: 升級依賴

(2)scope

  • 修改檔案的範圍(包括但不限於 doc, middleware, proxy, core, config)

(3)subject

  • 用一句話清楚的描述這次提交做了什麼

(4)body

  • 補充 subject,適當增加原因、目的等相關因素,也可不寫。

(5)footer

  • 當有非相容修改時可在這裡描述清楚
  • 關聯相關 issue,如 Closes #1, Closes #2, #3
  • 如果功能點有新增或修改的,還需要關聯 chair-handbook 和 chair-init 的 MR,如 chair/doc!123

示例

1. 簡單示例

fix: xxx components render twice problem fixed
. git commit -m "fix: xxx components render twice problem fixed."

2. 複雜示例

fix($compile): couple of unit tests for IE9
Older IEs serialize html uppercased, but IE9 does not...
Would be better to expect case insensitive, unfortunately jasmine does
not allow to user regexps for throw expectations.
Document change on chair
/doc!123 Closes #392 Breaks foo.bar api, foo.baz should be used instead