Git commit message 规范

规范采用angular
脚手架使用conventional-changelog命令来生成changelog

参考

步骤分解

格式如下

<header>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Commit Message header

commit Message header 添加分为三个环节：类型: (涉及范围) 信息

txt

<type>(<scope>可选): <short summary>
  │       │             │
  │       │             └─⫸ 主要描述，尽量简短
  │       │
  │       └─⫸ Commit Scope: common | 业务模块[挂号 就诊人 用户子系统] 等等
  │
  └─⫸ Commit Type: build|ci|docs|feat|fix|perf|refactor|test

⚠️ 注意

在代码块第一行的:的后面需要一个空格字符作为分割，没有加空格会导致conventional-changelog无法识别自动生成changelog

type

build: 影响构建系统或外部依赖的更改(示例范围:gulp, broccoli, npm)
ci: 更改我们的ci配置文件和脚本(示例:CircleCi, SauceLabs)
docs: 文档的改变
feat: 功能
fix: 修复的bug
perf: 改进性能的代码更改
refactor: 重构
test: 添加缺失的测试或纠正现有的测试

scope

可选

没有统一的约定，一般提交时填写涉及的范围即可（公共模块 | 业务模块）

message

*必填

信息尽可能简洁。

大多数情况下，提交记录在commit header已经足够，较少情况使用多行情况，如要使用在信息头与内容之间空格即可

例子

方式一：命令行提交

bash

git add .

git commit - m 'feat(common): util 中加入节流函数'
# or
git commit - m 'fix(挂号流程): 缺少接口返回异常的回调机制'

方式二：IDE 或 vscode 中提交

git-commit

插件生成的 changeLog

bash

pnpm i conventional-changelog

# 在项目根目录生成 Changelog.md 文件
conventional-changelog -p angular -i Changelog.md -s

生成预览

markdown

## [1.0.303](https://e.coding.net/haodf/iHospiatl_front/iHosService/compare/1.0.301...1.0.303) (2023-03-30)


### Bug Fixes

* **挂号:** 锁号流程字段修改 ([3203eb3](https://e.coding.net/haodf/iHospiatl_front/iHosService/commits/3203eb35c4848c73aff424b47144cf569d5d2895))
* 在医生主页进入到选择时间段缺少就诊人信息 ([7619467](https://e.coding.net/haodf/iHospiatl_front/iHosService/commits/761946774b5a8b31ea105050ee649d130a9e2238))


### Features

* 添加查询就诊卡接口 ([b4beda6](https://e.coding.net/haodf/iHospiatl_front/iHosService/commits/b4beda61ae07e02caccd93b4991242ac6fb53114))
* 添加就诊人绑卡流程变更 ([279e479](https://e.coding.net/haodf/iHospiatl_front/iHosService/commits/279e479a7b33299816ecdfdc5132515df6ab0c11))
* **住院清单:** 新增合计字段 ([8066dd1](https://e.coding.net/haodf/iHospiatl_front/iHosService/commits/8066dd1eb1c794d8c197cef8aca68ec6aeabffd1))


### Performance Improvements

* 多平台配置优化 ([e6809a1](https://e.coding.net/haodf/iHospiatl_front/iHosService/commits/e6809a19aeb4e2a0c1cd5b3b64e14a6cb76052fd))
* 接口更换字段 ([e2d26a4](https://e.coding.net/haodf/iHospiatl_front/iHosService/commits/e2d26a4673dae3b3360c65e8c2e5f5242a865443))
* 就医须知等待数据加载完毕才显示 ([70dc39e](https://e.coding.net/haodf/iHospiatl_front/iHosService/commits/70dc39e3e8a4598c4879d8074ecc86b96e1545dd))
* 优化弹窗提示用法 ([74e3771](https://e.coding.net/haodf/iHospiatl_front/iHosService/commits/74e3771f39e08c0bfabbbb7d4412f1d35def6342))

Git commit message 规范 ​

参考 ​

步骤分解 ​

Commit Message header ​

type ​

scope ​

message ​

例子 ​

插件生成的 changeLog ​

生成预览 ​