README.md

commitlint-config-befe

commitlint config preet for baidu BEFE.

安装

npm install commitlint-config-befe @commitlint/cli husky -D

使用

在 package.json 中书写：

{
  "commitlint": {
    "extends": ["commitlint-config-befe"]
  },
  "husky": {
    "hooks": {
      "commit-msg": "commitlint -e $HUSKY_GIT_PARAMS"
    }
  }
}

同时推荐 npm install -g commitizen 全局注入了 git cz，用来引导式书写规范的 commit message，十分适合于不熟悉的同学。

Related

• conventional-changelog - 根据 commit message 生成 changelog
• commitlint - Lint commit messages
• conventional-changelog-befe - conventional-changelog 预设

License

MIT