conventional-changelog中BREAKING CHANGE的正确使用格式
2025-05-28 01:18:45作者:翟萌耘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格式说明
遵循这些规范将大大提升项目的可维护性和自动化工具的使用效果。
登录后查看全文
热门项目推荐
相关项目推荐
atomcodeClaude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed. Get StartedRust0216
cann-learning-hubCANN 学习中心仓,支持在线互动运行、边学边练,提供教程、示例与优化方案,一站式助力昇腾开发者快速上手。Jupyter Notebook0138
uni-appA cross-platform framework using Vue.jsJavaScript08
GLM-5.2智谱开源 GLM-5.2,这是针对长文本任务的最新旗舰模型。相较于前代产品 GLM-5.1,它在长文本任务处理能力上实现了显著飞跃,并且首次在稳定的 100 万 token 上下文中提供这一能力。Jinja00
SwanLab⚡️SwanLab - an open-source, modern-design AI training tracking and visualization tool. Supports Cloud / Self-hosted use. Integrated with PyTorch / Transformers / LLaMA Factory / veRL/ Swift / Ultralytics / MMEngine / Keras etc.Python00
tiny-universe《大模型白盒子构建指南》:一个全手搓的Tiny-UniverseJupyter Notebook03
热门内容推荐
最新内容推荐
项目优选
收起
deepin linux kernel
C
32
16
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
471
465
Ascend Extension for PyTorch
Python
758
968
昇腾LLM分布式训练框架
Python
186
231
本项目是CANN提供的神经网络类计算算子库,实现网络在NPU上加速计算。
C++
698
1.4 K
本项目是CANN提供的transformer类大模型算子库,实现网络在NPU上加速计算。
C++
878
2.03 K
暂无描述
Dockerfile
780
5.08 K
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
70
22
本仓库是 Flutter SDK 与 Flutter Engine 的 OpenHarmony 适配版本,由 CPF-Flutter 团队维护。开发者可使用熟悉的 Flutter 技术栈开发 OpenHarmony 应用,3.35.7 及以后的适配版本可基于本仓库源码构建支持 OpenHarmony 的 Flutter Engine。
Dart
1.04 K
271
Claude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed.
Get Started
Rust
2.08 K
216