mcpField
G
gen-changelog

gen-changelog

github.com/moonshotaiDevelopment11.4k46 installsUpdated 5w ago
Repository

About gen-changelog

gen-changelog is a skill for preparing changelog entries for the current branch relative to main and syncing them to the documentation site. It covers scoped package changelogs, Chinese translations, and a separate format for breaking changes.

Key features

  1. 01Compare branch changes with main
  2. 02Write user-facing changelog entries
  3. 03Update scoped package changelogs
  4. 04Sync English changelog to docs
  5. 05Translate entries into Chinese
  6. 06Document breaking changes

Use cases

  1. 01Prepare release notes from branch changes
  2. 02Record a package-specific change
  3. 03Explain migration steps for breaking changes

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/moonshotai/kimi-cli --skill gen-changelog

After installing, type/gen-changelogin Claude Code to confirm it loaded.

Details

From the project README

Generate changelog entries for changes on the current branch relative to main, then sync to the docs site.

Steps

  1. Inspect: git log main..HEAD --oneline + git diff main..HEAD --stat.
  2. Edit root CHANGELOG: add bullets under ## Unreleased in CHANGELOG.md using the prefix table below. For changes scoped to a subpackage under packages/ or sdks/, also update that subpackage's CHANGELOG.md — subpackage CHANGELOGs follow their own prefix conventions (e.g. packages/kosong/CHANGELOG.md uses provider prefixes like Kimi: / Anthropic:); only the root CHANGELOG follows the table below.
  3. Sync English docs: node docs/scripts/sync-changelog.mjs.
  4. Translate to Chinese: hand-write equivalents under ## 未发布 in docs/zh/release-notes/changelog.md. Use the full-width colon :. Follow docs/AGENTS.md terminology.
  5. Breaking changes: if any, add a section under ## Unreleased in docs/en/release-notes/breaking-changes.md with Affected + Migration subsections, and under ## 未发布 in docs/zh/release-notes/breaking-changes.md with 受影响 + 迁移 subsections.

Entry format

- <Prefix>: <verb-led sentence, readable standalone> — <optional rationale / before-after / migration>
  • First sentence stands alone — readers should know after one sentence whether the bullet matters to them.
  • One change per bullet. No ; also, ; and, or nested em-dashes. Two changes = two bullets.
  • Verb-led: Fix … / Add … / Switch … / Bump ….
  • User-meaningful only. No internal refactors, test churn, or CI tweaks — except Lib: for SDK-facing changes.

Prefixes — pick from this list, do not invent new ones

PrefixScope
ShellInteractive TUI: keys, status bar, slash commands, terminal rendering
Webkimi web
Viskimi vis tracing visualizer
CLITop-level flags, subcommands, --print / --yolo / --afk
ACPZed / JetBrains and other ACP integrations
CoreAgent runtime, step loop, approval, quota, turns, background tasks
ToolAny built-in tool; name the specific tool in the body (ReadFile, Grep, Todo, Plan, …)
SkillSkill discovery/loading, Flow, Loop (always singular — not Skills:)
MCPMCP server integration
PluginPlugin system, kimi plugin subcommands
LLMProvider-agnostic or cross-provider; name the provider in the body (Kimi / Anthropic / OpenAI / DeepSeek …). Do not create per-provider prefixes
KosongChanges to the kosong LLM abstraction layer surfaced in the root CHANGELOG (the subpackage's own CHANGELOG uses provider prefixes)
WireWire protocol events, version
AuthOAuth, token refresh, /login
ConfigConfig schema, env vars
LibSDK-facing API changes
BuildNix / Rust / Python / packaging

When unsure, match an existing entry of the same kind. Prefer this list; if you genuinely need a new prefix, raise it with maintainers and update this table in the same PR so the convention stays single-sourced.

Ordering: within each version, group bullets by prefix in the order of the table above. Order within a prefix is free — keep the development order.

Highlights

Starting from the next release, add **Highlights**: … under each version header (1–3 items most users will notice); mirror it as **亮点**:… in Chinese. Skip on releases that are only internal or Lib:. Highlights summarize — every highlighted item still needs its full bullet below. Do not backfill historical versions.

Comments

Markdown supported