JiuMao前端团队 CommitLint 配置
- 安装commitlint
yarn add -D @commitlint/cli husky
- 项目添加
commitlint.config.js配置文件
const { rules } = require('@jiumao/commitlint-config');
module.exports = {
rules
};
- package.json添加如下代码
"scripts": {
"commitmsg": "commitlint -E HUSKY_GIT_PARAMS"
},
"husky": {
"hooks": {
"commit-msg": "npm run commitmsg"
}
}
提交格式如下
<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>
提交信息应该包含Header(必填)、Body(选填)和Footer(选填)
Header:
<type>(<scope>): <subject>
: 用来説明commit的类别, 可选值如下
feat: 新功能fix: BUG修复docs: 文档style: 代码格式(不影响代码运行的变动)refactor: 重构test: 关于测试chore: 构建过程或辅助工具的变动revert: 还原代码
: 表示影响的范围 选填
: commit 目的的简短描述
Body: 本次 commit 的详细描述，可以分成多行
Footer 只用于两种情况 关联Issue 和 关闭Issue
关联Issue: 格式: Issue #1, #2, #3 关闭Issue: 格式: Close #1, #2, #3
feat(document module): 添加了新功能
添加**新功能
- 功能1
- 功能2
Issue #1, #2
Close #1