git commit 规范及自动化

规范描述

commit message需要包括两部分内容：header和body

• header（推荐）：简要描述此次commit的改动范围/内容
• body（可选）：若代码出现较大改变时填写

header 格式

header部分只有一行，包括三个字段：

type 必填

说明commit类型，只允许使用以下标识

• breaking：不兼容的改动，接口删除、数据库字段更新等，具体不兼容的部分用scope说明
• feat：新功能(feature)
• fix：修复bug
• perf：优化（包括提升性能、体验）
• refactor：重构（不是新增功能，也不是修改bug的代码改动）
• docs：文档调整(documentation)
• style：格式调整
• test：测试调整（增加测试用例等）
• chore：构建过程或辅助工具的变动
• revert：回滚到某个版本

scope 选填

说明commit更改的文件名，多个用“,”分开

subject

commit简短描述

项目配置

1. 安装

2. 配置文件

在项目目录下，新建配置文件 commitlint.config.js

在项目目录下，新建配置文件 .cz-config.js

在package.json文件中增加相关配置

3. 自动生成 Change Log

运行 npm run changelog

虽然只能生成简短的 commit 提交记录，但是已经提供了框架和基本 log

手动修改生成后的 log 文件即为项目 log