关于 gen-changelog
gen-changelog 是用于整理当前分支相对 main 的变更并同步到文档站点的技能。它涵盖子软件包 changelog、中文翻译,以及破坏性变更的专门格式。
主要功能
- 01比较当前分支与 main 的变更
- 02撰写面向用户的 changelog 条目
- 03更新指定软件包的 changelog
- 04同步英文 changelog 至文档
- 05将条目翻译为中文
- 06记录破坏性变更
适用场景
- 01根据分支变更准备发布说明
- 02记录软件包专属变更
- 03说明破坏性变更的迁移步骤
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ moonshotai/ kimi-cli --skill gen-changelog安装后在 Claude Code 中输入/gen-changelog确认已加载。
详细介绍
为当前分支相对于 main 的更改生成更新日志条目,然后同步到文档网站。
步骤
- 检查:
git log main..HEAD --oneline+git diff main..HEAD --stat。 - 编辑根目录 CHANGELOG:使用下方的前缀表,在
CHANGELOG.md的## Unreleased下添加条目。对于作用于packages/或sdks/下子包的更改,还要更新该子包的CHANGELOG.md—— 子包 CHANGELOG 遵循各自的前缀约定(例如,packages/kosong/CHANGELOG.md使用Kimi:/Anthropic:等提供方前缀);只有根目录的 CHANGELOG 遵循下方的表格。 - 同步英文文档:
node docs/scripts/sync-changelog.mjs。 - 翻译为中文:在
docs/zh/release-notes/changelog.md的## 未发布下手动撰写对应条目。使用全角冒号:。遵循docs/AGENTS.md中的术语规范。 - 重大变更:如有重大变更,在
docs/en/release-notes/breaking-changes.md的## Unreleased下添加一个章节,包含 Affected + Migration 小节;并在docs/zh/release-notes/breaking-changes.md的## 未发布下添加一个章节,包含 受影响 + 迁移 小节。
条目格式
- <Prefix>: <verb-led sentence, readable standalone> — <optional rationale / before-after / migration>
- 第一句话单独成句——读者只看这一句话就应能判断该条目是否与自己相关。
- 每条只写一项更改。 不要使用
; also、; and或嵌套的破折号。两项更改 = 两条。 - 以动词开头:
Fix …/Add …/Switch …/Bump …。 - 只写对用户有意义的内容。 不包括内部重构、测试变动或 CI 调整——但 SDK 面向的更改可使用
Lib:。
前缀——从列表中选择,不要自创
| 前缀 | 范围 |
|---|---|
Shell | 交互式 TUI:按键、状态栏、斜杠命令、终端渲染 |
Web | kimi web |
Vis | kimi vis 跟踪可视化工具 |
CLI | 顶层标志、子命令、--print / --yolo / --afk |
ACP | Zed / JetBrains 及其他 ACP 集成 |
Core | Agent 运行时、步骤循环、审批、配额、轮次、后台任务 |
Tool | 任意内置工具;在正文中注明具体工具名称(ReadFile、Grep、Todo、Plan 等) |
Skill | Skill 发现/加载、Flow、Loop(始终使用单数形式——不要写 Skills:) |
MCP | MCP 服务集成 |
Plugin | 插件系统、kimi plugin 子命令 |
LLM | 与提供方无关或跨提供方;在正文中注明提供方(Kimi / Anthropic / OpenAI / DeepSeek 等)。不要创建按提供方区分的前缀 |
Kosong | 在根目录 CHANGELOG 中体现的 kosong 大模型抽象层更改(子包自己的 CHANGELOG 使用提供方前缀) |
Wire | Wire 协议事件、版本 |
Auth | OAuth、令牌刷新、/login |
Config | 配置架构、环境变量 |
Lib | 面向 SDK 的 API 更改 |
Build | Nix / Rust / Python / 打包 |
不确定时,参考同类现有条目。优先使用此列表;若确实需要新前缀,请与维护者沟通,并在同一个 PR 中更新此表,确保约定只有一个权威来源。
排序:每个版本内,按上表顺序对条目按前缀分组。每个前缀组内的顺序不限——保持开发顺序即可。
亮点
从下一个版本开始,在每个版本标题下添加 **Highlights**: …(1–3 项大多数用户会注意到的内容);中文对应写为 **亮点**:…。仅包含内部更改或 Lib: 条目的版本可跳过。亮点是摘要——每项亮点仍需在下方列出完整条目。不要补写历史版本。
评论
支持 Markdown