SuperAPI AI 工具集

adding-changelog-entries

编程与开发

查看项目

更新于 10-16 03:51

技能介绍

用途:该技能面向 Flutter DevTools 生态中已发布包(devtools_shared、devtools_app_shared、devtools_extensions)的变更文档工作,帮助在 CHANGELOG.md 中按规范添加日志条目。

主要能力与规则:

  1. 检查发布状态:不得向已发布版本(例如 # 12.1.0)添加条目。确定区段标题前,必须先查看 pub.dev 上该包的版本列表(如 https://pub.dev/packages/<package_name>/versions)。若版本尚未发布,应加上下一个数字 -wip 标记(例如 ## 0.5.1-wip),或沿用该文件既有约定(如 not released)。同时要匹配该文件中版本既有的标题级别(H1 或 H2)。避免使用 # WIP 这类通用占位标题。
  2. 新版本标题:若需要提升版本号,必须先按 updating-package-versions 的说明更新 pubspec.yaml 中的包版本,然后在变更日志文件中为新版本新增标题(例如 ## 0.5.1-wip),再添加条目。
  3. 准确区分包:针对某个包变更日志条目的清理或编辑,必须严格属于该包的路径。例如 devtools_app 中的改动不应在 devtools_shared 中产生条目。
  4. 简洁与准确:清晰描述改了什么以及为什么改。避免没有上下文的笼统描述,例如 “Fixes missing deprecation message”。应具体说明新增或移除了什么。
  5. 仅限用户可见变更:只有在变更对包的使用者有实际意义时才添加日志条目。不要包含内部重构说明或其他用户不关心的琐碎改动。

使用方式与适用场景:在维护上述 DevTools 发布包、需要记录用户可见变更并发布版本时使用,按上述顺序先确认发布状态与版本号,再写入对应包的 CHANGELOG.md。

限制:资料未提供该技能的具体实施命令、自动化工具或配置方式;具体版本号、发布状态与文件既有约定需以实际仓库和 pub.dev 页面为准。