conventional-changelog中BREAKING CHANGE的正确使用格式
2025-05-28 14:56:56作者:翟萌耘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格式说明
遵循这些规范将大大提升项目的可维护性和自动化工具的使用效果。
登录后查看全文
热门项目推荐
相关项目推荐
ERNIE-4.5-VL-28B-A3B-ThinkingERNIE-4.5-VL-28B-A3B-Thinking 是 ERNIE-4.5-VL-28B-A3B 架构的重大升级,通过中期大规模视觉-语言推理数据训练,显著提升了模型的表征能力和模态对齐,实现了多模态推理能力的突破性飞跃Python00
Kimi-K2-ThinkingKimi K2 Thinking 是最新、性能最强的开源思维模型。从 Kimi K2 开始,我们将其打造为能够逐步推理并动态调用工具的思维智能体。通过显著提升多步推理深度,并在 200–300 次连续调用中保持稳定的工具使用能力,它在 Humanity's Last Exam (HLE)、BrowseComp 等基准测试中树立了新的技术标杆。同时,K2 Thinking 是原生 INT4 量化模型,具备 256k 上下文窗口,实现了推理延迟和 GPU 内存占用的无损降低。Python00
MiniMax-M2MiniMax-M2是MiniMaxAI开源的高效MoE模型,2300亿总参数中仅激活100亿,却在编码和智能体任务上表现卓越。它支持多文件编辑、终端操作和复杂工具链调用Python00
Spark-Prover-X1-7BSpark-Prover 是由科大讯飞团队开发的专用大型语言模型,专为 Lean4 中的自动定理证明而设计。该模型采用创新的三阶段训练策略,显著增强了形式化推理能力,在同等规模的开源模型中实现了最先进的性能。Python00
MiniCPM-V-4_5MiniCPM-V 4.5 是 MiniCPM-V 系列中最新且功能最强的模型。该模型基于 Qwen3-8B 和 SigLIP2-400M 构建,总参数量为 80 亿。与之前的 MiniCPM-V 和 MiniCPM-o 模型相比,它在性能上有显著提升,并引入了新的实用功能Python00
Spark-Formalizer-X1-7BSpark-Formalizer 是由科大讯飞团队开发的专用大型语言模型,专注于数学自动形式化任务。该模型擅长将自然语言数学问题转化为精确的 Lean4 形式化语句,在形式化语句生成方面达到了业界领先水平。Python00
GOT-OCR-2.0-hf阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00
项目优选
收起
deepin linux kernel
C
24
7
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
316
2.74 K
仓颉编译器源码及 cjdb 调试工具。
C++
124
852
Ascend Extension for PyTorch
Python
155
178
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
639
246
TorchAir 支持用户基于PyTorch框架和torch_npu插件在昇腾NPU上使用图模式进行推理。
Python
241
85
暂无简介
Dart
606
136
React Native鸿蒙化仓库
JavaScript
239
310
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.03 K
470
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
364
3.02 K