寫好 Commit message 好處多多:
- 1、統一團隊Git commit 日志風格
- 2、方便日后 Reviewing Code
- 3、幫助我們寫好 Changelog
- 4、能很好的提升項目整體質量
業界比較推崇 Angular 的 commit 規范 http://suo.im/4rsYee
Commit message 包括三個部分:Header,Body 和 Footer。完整格式如下:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
1) type
提交 commit 的類型,包括以下幾種
- feat: 新功能
- fix: 修復問題
- docs: 修改文檔
- style: 修改代碼格式,不影響代碼邏輯
- refactor: 重構代碼,理論上不影響現有功能
- perf: 提升性能
- test: 增加修改測試用例
- chore: 修改工具相關(包括但不限於文檔、代碼生成等)
2) scope
修改文件的范圍,比如:視圖層、控制層、docs、config, plugin
3) subject
- subject 是 commit 目的的簡短描述(用一句話清楚的描述這次提交做了什么),不超過50個字符
4) body
- 補充 subject 添加詳細說明,可以分成多行,適當增加原因、目的等相關因素,也可不寫
5 ) footer
- 當有非兼容修改(Breaking Change)時必須在這里描述清楚
- 關閉issue或是鏈接到相關文檔,如 Closes #1, Closes #2, #3