Appearance
Git Commit Message 规范
1. Angular 规范
1.1. 提交格式
每条 Commit Message 包含三个部分:Header、Body 和 Footer,其中 Header 部分是必须的,Body 和 Footer 可以省略,但不管是哪一个部分,任何一行都不得超过 72 个字符,每个部分之间需要空一行。
Text
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>Header(必填)
type:提交的类别,功能、修复等;scope:影响的范围,可选,如模块、组件、文件名;subject:简短描述,不超过 50 个字符,首字母小写,不加句号。
Body(可选)
- 更详细的描述,说明修改的动机、与之前行为的对比。
Footer(可选)
- 不兼容变更说明(BREAKING CHANGE)
- 关联 Issue 或关闭 Issue,如
Closes #123
1.2. type 说明
1.2.1. 普通开发项目
type | 中文 | 说明 |
|---|---|---|
feat | 功能 | 新功能(Feature) |
fix | 修复 | 修复 Bug |
change | 变更 | 破坏性变更(Breaking Change) |
docs | 文档 | 文档相关(仅修改文档) |
style | 排版 | 不影响逻辑的代码修改(空格、缩进、分号等) |
refactor | 重构 | 代码重构(既不是新功能也不是修复 Bug) |
test | 测试 | 增加或修改测试 |
perf | 性能 | 性能优化 |
build | 构建 | 构建系统或外部依赖相关的更改,影响最终产物(打包结果) |
ci | 集成 | 修改 CI/CD 部署脚本(如 GitHub Actions),不影响最终产物(打包结果) |
revert | 回滚 | 回滚某个提交 |
chore | 杂项 | 其它 |
1.2.2. 文档仓库项目
type | 中文 | 说明 |
|---|---|---|
docs | 文档 | 新增页面、章节或主要内容的更新 |
fix | 修复 | 修复拼写错误、无效链接、内容上的事实错误等 |
style | 排版 | 调整文档格式、代码高亮、标点、空格、缩进等,不改变内容含义 |
refactor | 重构 | 调整文档结构、移动/重命名文件 |
build | 构建 | 构建系统或外部依赖相关的更改,影响最终产物(打包结果) |
ci | 集成 | 修改 CI/CD 部署脚本(如 GitHub Actions),不影响最终产物(打包结果) |
revert | 回滚 | 回滚某个提交 |
chore | 杂项 | 其它 |
1.3. 示例
简单提交
Textfeat(auth): add JWT login authenticationText功能(鉴权):新增 JWT 登录鉴权带 body 的提交
Textfix(cart): fix coupon not applied during checkout The reason was that discountService did not load the latest configuration during initialization. Now it fetches the configuration again before checkout.Text修复(购物车):修复结算时优惠券未生效的问题 原因是 discountService 在初始化时未加载最新配置。现在改为在结算前重新拉取配置。包含 BREAKING CHANGE 的提交
Textrefactor(api): remove legacy order query API BREAKING CHANGE: /api/v1/orders has been removed, please use /api/v2/orders insteadText重构(API):移除旧版订单查询接口 破坏性变更:/api/v1/orders 已被删除,请使用 /api/v2/orders