标准化 Git Message
文章目录
使用Commitizen,标准化Git的Commit Message。
AngularJS Commit 规范
- Commit Message 格式
<type>(<scope>): <subject>
<空行>
<body>
<空行>
<footer>
- 释意
- type
- feat:新功能
- fix:修复问题
- docs:文档
- style: 格式
- refactor:重构
- test:增加测试
- chore:构建过程或辅助工具的变动
- scope 影响范围
- subject 简要描述
- 以动词开头,使用第一人称现在时,比如change
- 首字母不要大写
- 结尾不用句号(.)
- body 详尽描述
- footer 不兼容变更和Issue关闭的信息
- revert 撤销修改
- 以revert:开头,后面紧跟前面描述的Header部分
- 必须要记录撤销前Commit的SHA值
- type
工具:Commitizen
- 安装node
// 法一
brew install node
// 法二
brew install nvm
nvm install node
- 安装Commitizen
npm install -g commitizen
// 安装生成changelog的工具
npm install -g conventional-changelog
npm install -g conventional-changelog-cli
// 检测是否安装成功
npm ls -g -depth=0
- 项目下初始化
// 初始化npm
npm init --yes
// 使支持Angular的Commit message格式
commitizen init cz-conventional-changelog --save --save-exact
// 生成changelog
conventional-changelog -p angular -i CHANGELOG.md -s
// 用git cz代替git commit
git cz