conventional-changelog中BREAKING CHANGE的正确使用格式
2025-05-28 10:55:17作者:翟萌耘Ralph
在软件开发过程中,commit message的规范化对于版本管理和变更日志生成至关重要。conventional-changelog作为一款流行的commit message规范工具,对BREAKING CHANGE有特定的格式要求。
常见错误格式
许多开发者可能会写出类似以下的commit message:
feat: test message
---------
Co-authored-by: Mee <me.e@me.com>
BREAKING CHANGE: test
这种格式虽然看起来合理,但实际上会导致semantic-release等工具无法正确识别BREAKING CHANGE关键字,从而影响版本号的自动升级和变更日志的生成。
正确的BREAKING CHANGE格式
conventional-changelog要求BREAKING CHANGE必须出现在commit message的特定位置:
feat: test message
BREAKING CHANGE: test
---------
Co-authored-by: Mee <me.e@me.com>
格式规范详解
- 首行:必须包含类型(如feat/fix等)和简要描述
- BREAKING CHANGE:必须紧接在首行之后,位于分隔线之前
- 分隔线:用于分隔主要内容和元数据(如Co-authored-by)
- 元数据:出现在分隔线之后
为什么格式如此重要
- 工具兼容性:semantic-release等工具会按照特定模式解析commit message
- 版本控制:只有正确格式的BREAKING CHANGE才会触发主版本号升级
- 变更日志:确保变更信息被正确归类到变更日志的相应部分
- 团队协作:统一的格式便于团队成员理解和维护
最佳实践建议
- 在团队中建立commit message规范
- 使用commitizen等工具辅助生成符合规范的commit message
- 在CI流程中加入commit message格式检查
- 对于大型变更,考虑在PR模板中加入commit message格式说明
遵循这些规范将大大提升项目的可维护性和自动化工具的使用效果。
登录后查看全文
热门项目推荐
相关项目推荐
kernelopenEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。C075
MiniMax-M2.1从多语言软件开发自动化到复杂多步骤办公流程执行,MiniMax-M2.1 助力开发者构建下一代自主应用——全程保持完全透明、可控且易于获取。Python00
kylin-wayland-compositorkylin-wayland-compositor或kylin-wlcom(以下简称kywc)是一个基于wlroots编写的wayland合成器。 目前积极开发中,并作为默认显示服务器随openKylin系统发布。 该项目使用开源协议GPL-1.0-or-later,项目中来源于其他开源项目的文件或代码片段遵守原开源协议要求。C01
PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00
GLM-4.7GLM-4.7上线并开源。新版本面向Coding场景强化了编码能力、长程任务规划与工具协同,并在多项主流公开基准测试中取得开源模型中的领先表现。 目前,GLM-4.7已通过BigModel.cn提供API,并在z.ai全栈开发模式中上线Skills模块,支持多模态任务的统一规划与协作。Jinja00
agent-studioopenJiuwen agent-studio提供零码、低码可视化开发和工作流编排,模型、知识库、插件等各资源管理能力TSX0130
Spark-Formalizer-X1-7BSpark-Formalizer 是由科大讯飞团队开发的专用大型语言模型,专注于数学自动形式化任务。该模型擅长将自然语言数学问题转化为精确的 Lean4 形式化语句,在形式化语句生成方面达到了业界领先水平。Python00
项目优选
收起
deepin linux kernel
C
27
11
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
462
3.44 K
Ascend Extension for PyTorch
Python
269
309
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
190
75
暂无简介
Dart
714
171
React Native鸿蒙化仓库
JavaScript
284
331
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
843
421
华为昇腾面向大规模分布式训练的多模态大模型套件,支撑多模态生成、多模态理解。
Python
105
119
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
10
1
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.26 K
692