https://github.com/lzm0x219/commitlint-config

⚙️ A shareable commitlint config enforcing conventional commits.
https://github.com/lzm0x219/commitlint-config

Last synced: about 1 month ago
JSON representation

⚙️ A shareable commitlint config enforcing conventional commits.

• Host: GitHub
• URL: https://github.com/lzm0x219/commitlint-config
• Owner: lzm0x219
• License: mit
• Created: 2021-10-14T10:27:13.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-10T15:50:44.000Z (2 months ago)
• Last Synced: 2024-10-14T02:49:15.220Z (2 months ago)
• Language: JavaScript
• Size: 527 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
English | [简体中文](./README.zh-Hans.md)

# @0x219/commitlint-config

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier) ![npm (scoped)](https://img.shields.io/npm/v/@0x219/commitlint-config?style=flat-square) ![npm](https://img.shields.io/npm/dm/@0x219/commitlint-config?color=yellow&style=flat-square) ![NPM](https://img.shields.io/npm/l/@0x219/commitlint-config?style=flat-square)

⚙️ A shareable `commitlint` config enforcing [conventional commits](https://www.conventionalcommits.org/en/v1.0.0-beta.4/).

## Getting started

Install the package in your project directory with:

```bash

// with npm

npm install @commitlint/cli @0x219/commitlint-config --save-dev

// with yarn

yarn add @commitlint/cli @0x219/commitlint-config --save-dev

```

In commitlint.config.js:

```js

module.exports = {

  extends: ['@0x219'],

};

```

## Rules

The most common commit conventions follow this pattern:

```

[optional scope]: 

[optional body]

[optional footer(s)]

```

### Type

Type cannot be empty, must be lowercase.（`build` | `break` | `chore` | `ci` | `docs` | `feat` | `fix` | `perf` | `refactor` | `revert` | `release` | `style`  | `test` | `wip`）

### Subject

The subject cannot be empty and cannot end with. Never allowed "sentence-case", "start-case", "pascal-case", "upper-case".

### Body

There must be a space before the body, and the maximum length is 100.

### Footer

There must be a space before the footer, and the maximum length is 100.

## Thanks

[commitlint](https://github.com/conventional-changelog/commitlint) - 📓 Lint commit messages.

## License

[MIT](./LICENSE) ⓒ Taoist Priest