https://github.com/be-fe/commitlint-config-befe

commitlint config preet for baidu BEFE
https://github.com/be-fe/commitlint-config-befe

Last synced: about 14 hours ago
JSON representation

commitlint config preet for baidu BEFE

• Host: GitHub
• URL: https://github.com/be-fe/commitlint-config-befe
• Owner: be-fe
• License: mit
• Created: 2018-10-26T03:36:12.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2018-10-26T04:16:13.000Z (about 6 years ago)
• Last Synced: 2024-11-06T03:29:52.109Z (about 2 months ago)
• Language: JavaScript
• Size: 89.8 KB
• Stars: 0
• Watchers: 10
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: License

Awesome Lists containing this project

README

        
# commitlint-config-befe

[![build status](https://img.shields.io/travis/be-fe/commitlint-config-befe/master.svg?style=flat-square)](https://travis-ci.org/be-fe/commitlint-config-befe)

[![Test coverage](https://img.shields.io/codecov/c/github/be-fe/commitlint-config-befe.svg?style=flat-square)](https://codecov.io/github/be-fe/commitlint-config-befe?branch=master)

[![NPM version](https://img.shields.io/npm/v/commitlint-config-befe.svg?style=flat-square)](https://www.npmjs.com/package/commitlint-config-befe)

[![NPM Downloads](https://img.shields.io/npm/dm/commitlint-config-befe.svg?style=flat-square&maxAge=43200)](https://www.npmjs.com/package/commitlint-config-befe)

> commitlint config preet for baidu BEFE.

## 安装

```bash

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

```

## 使用

在 `package.json` 中书写：

```json

{

  "commitlint": {

    "extends": ["commitlint-config-befe"]

  },

  "husky": {

    "hooks": {

      "commit-msg": "commitlint -e $HUSKY_GIT_PARAMS"

    }

  }

}

```

同时推荐 `npm install -g commitizen`

全局注入了 `git cz`，用来引导式书写规范的 commit message，十分适合于不熟悉的同学。

![](https://github.com/commitizen/cz-cli/raw/master/meta/screenshots/add-commit.png)

## Related

- [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) - 根据 commit message 生成 changelog

- [commitlint](https://github.com/marionebl/commitlint) - Lint commit messages

- [conventional-changelog-befe](https://github.com/be-fe/conventional-changelog-befe) - conventional-changelog 预设

## License

MIT