# commitlint-config-cyber

**Repository Path**: zhangrunk/commitlint-config-cyber

## Basic Information

- **Project Name**: commitlint-config-cyber
- **Description**: commitlint-config-cyber
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-03-11
- **Last Updated**: 2024-03-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

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

配置如下即可:
```js
module.exports = {
    "extends": "@jd-antelope/commitlint-config-cyber"
}
```

:::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     | 不属于以上类型的其他类型(日常事务)                                               |