# @jd-antelope/commitlint-config-selling

> commitlint config base version

Latest version **0.0.3** (published 2022-02-28) · ISC license · 0 weekly downloads

## Install

```sh
npm install @jd-antelope/commitlint-config-selling
pnpm add @jd-antelope/commitlint-config-selling
yarn add @jd-antelope/commitlint-config-selling
bun add @jd-antelope/commitlint-config-selling
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2022-02-28 |
| First published | 2022-02-28 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 4.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 88 |
| Author | hawleyHuo |
| Maintainers | zxy25, hawleyhuo |
| Keywords | commitlint |

## Links

- npm: https://www.npmjs.com/package/@jd-antelope/commitlint-config-selling
- Repository: https://github.com/jd-antelope/s-lint
- Homepage: https://github.com/jd-antelope/s-lint#readme
- Issues: https://github.com/jd-antelope/s-lint/issues
- npm.io page: https://npm.io/package/@jd-antelope/commitlint-config-selling

## Dependencies (2)

- [@commitlint/cli](https://npm.io/package/@commitlint/cli.md) ^13.1.0
- [@commitlint/config-conventional](https://npm.io/package/@commitlint/config-conventional.md) ^13.1.0

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 0.0.3 (latest) — 2022-02-28

## README

## CommitLint规范
是商羚前端CommitLint规范
#### 安装
```shell
npm install commitlint-config-selling -D
# OR
yarn add commitlint-config-selling --dev
```
#### 使用
在你的工程根目录下创建一个`.commitlintrc.js`配置文件

配置如下即可:
```js
module.exports = {
    "extends": "commitlint-config-selling"
}
```

:::caution
如果项目之前安装过CommitLint相关的包，建议卸载，避免引入不必要的包。如`@commitlint/cli`、`@commitlint/config-conventional`等，直接在package.json搜索**commitlint**，相关的包全部卸载
:::
#### 规范
格式： `<type>[(scope)]: <description>`

示例

```bash
git commit -a -m 'build: xxxxx'
git commit -a -m 'feat(cli): xxxxx'
```

字段说明

| 字段        | 类型   | 说明                                                         | 必须 |
| ----------- | ------ | ------------------------------------------------------------ | ---- |
| type        | string | 用于表明我们这次提交的改动类型                               | 是   |
| scope       | string | 一个可选的修改范围。用于标识此次提交主要涉及到代码中哪个模块 | 否   |
| description | string | 一句话描述此次提交的主要内容，做到言简意赅                   | 是   |

type

| type 类型 | 说明                                                                             |
| --------- | -------------------------------------------------------------------------------- |
| build     | 主要目的是修改项目构建系统(例如 glup，webpack，rollup 的配置等)的提交            |
| ci        | 主要目的是修改项目继续集成流程(例如 Travis，Jenkins，GitLab CI，Circle 等)的提交 |
| docs      | 文档更新                                                                         |
| feat      | 新增功能                                                                         |
| fix       | bug 修复                                                                         |
| perf      | 优化                                                                             |
| refactor  | 重构代码                                                                         |
| style     | 不影响程序逻辑的代码修改(修改空白字符，补全缺失的分号等)                         |
| test      | 新增测试用例或是更新现有测试                                                     |
| revert    | 回滚某个更早之前的提交                                                           |
| chore     | 不属于以上类型的其他类型(日常事务)                                               |

---
_Source: https://npm.io/package/@jd-antelope/commitlint-config-selling · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._