用途:为 GitHub Pull Request 生成简洁的变更描述,控制在 150 词以内,内容涵盖新功能、缺陷修复和改进。
主要能力:当 PR 对代码库引入破坏性变更时,需单独用 ## Breaking Changes 章节清晰说明,帮助使用该代码的用户和开发者理解改了什么、为何改、如何适配新版本。可从 PR diff 中提取变更并做简明总结,重点给出清晰的 API 变更供用户跟进。
格式要求:破坏性变更描述使用无序列表,每项包含标题和用 diff 代码块展示的旧用法与新用法;章节标题固定为 ## Breaking Changes;使用英文撰写。示例:
Breaking Changes
- Added
idparameter toSidebar::new.
- Sidebar::new()
+ Sidebar::new("sidebar")
- Removed the
leftandrightmethods; usesideinstead.Default is left.
- Sidebar::right()
+ Sidebar::new("sidebar").side(Side::Right)
适用场景:提交或评审 PR 时撰写描述,尤其是涉及 crates/ui 的 API 破坏性变更。
限制:破坏性变更章节仅针对 crates/ui 的变更;描述需用英文;资料未提供安装命令、收费、平台或具体使用步骤。