規範git提交的信息
使用 commitizen cz-conventional-changelog
目的
規範團隊提交的信息,便於閱讀
安裝
- 安裝依賴包
npm i commitizen cz-conventional-changelog --save-dev
- 在package.json中增加
"config": { "commitizen": { "path": "./node_modules/cz-conventional-changelog" } }
配置
提交時,默認有9種消息類型
- feat: 新增feature
- fix: 修復bug
- docs: 僅僅修改了文檔,比如README, CHANGELOG, CONTRIBUTE等等
- style: 僅僅修改了空格、格式縮進、都好等等,不改變代碼邏輯
- refactor: 代碼重構,沒有加新功能或者修復bug
- perf: 優化相關,比如提升性能、體驗
- test: 測試用例,包括單元測試、集成測試等
- revert: 回滾到上一個版本
使用
提交時是用git cz 替代 git commit。