Agent skill

Changelog Writing

by xiajiajun516 in xiajiajun516/dsh-config-manager

写或修改 CHANGELOG.md(待发布条目、版本亮点段、GitHub Release 说明)时使用。含按改动性质分组落位、中英双语体例、发版前的两道门禁(三处版本号同步 + 亮点段抽取会 fail-fast)与写后自检命令。

MITAuto-check passedDevelopment

Install Changelog Writing

skills CLI
$ npx skills add xiajiajun516/dsh-config-manager --skill changelog-writing -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install xiajiajun516/dsh-config-manager changelog-writing --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/xiajiajun516/dsh-config-manager.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.dsh/skills/changelog-writing .claude/skills/changelog-writing && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
changelog-writing
GitHub stars
172
Token cost
~805 tokens
SKILL.md length
199 words
Files
1
Skills in repo
1
Repo updated
First seen
Licence
MIT

At a glance

写或修改 CHANGELOG.md(待发布条目、版本亮点段、GitHub Release 说明)时使用。含按改动性质分组落位、中英双语体例、发版前的两道门禁(三处版本号同步 + 亮点段抽取会 fail-fast)与写后自检命令。

  • Works in 5 steps: 落位:写进哪一段 → 体例:一条条目怎么写 → 发版时才做(不是现在) → …
  • Tasks that involve Changelog and release notes
  • SKILL.md covers 何时使用 / 何时跳过, 1. 落位:写进哪一段, 2. 体例:一条条目怎么写 and 3. 发版时才做(不是现在), plus 2 more sections
  • Calls python3, node and npm

What it does

Changelog Writing is an agent skill from xiajiajun516/dsh-config-manager. 写或修改 CHANGELOG.md(待发布条目、版本亮点段、GitHub Release 说明)时使用。含按改动性质分组落位、中英双语体例、发版前的两道门禁(三处版本号同步 + 亮点段抽取会 fail-fast)与写后自检命令。

Its SKILL.md is about 810 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Development, covering Changelog and release notes. It works with GitHub, DeepSeek and Model Context Protocol. The repository describes itself as: DeepSeek Harness (DSH) backup & restore plugin — export, import, migrate and sync your complete DSH configuration, plugins, MCP servers, skills and workspace. One-click migration… The licence is MIT.

When your agent uses it

  • Tasks that involve Changelog and release notes

Example prompts

  • “/changelog-writing”

Requirements

  • Python 3

Workflow steps

5 steps, taken from the step headings in SKILL.md.

  1. 落位:写进哪一段
  2. 体例:一条条目怎么写
  3. 发版时才做(不是现在)
  4. 写后自检(必须做)
  5. 常见错误

What it can do on your machine

Read from SKILL.md and the folder at commit 34092a5. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • python3
    • node
    • npm

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    Links to these hosts (documentation or services it may open):

    • keepachangelog.com

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Changelog Writing loads about 805 tokens when it runs. Until then it costs about 33 tokens; SKILL.md has 199 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~33
When it runs · the whole SKILL.md, loaded when a task matches
~805

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from xiajiajun516/dsh-config-manager at commit 34092a5, republished under its MIT licence (© xiajiajun516). 199 words, ~805 tokens.

Download SKILL.mdSave it as .claude/skills/changelog-writing/SKILL.md (or your agent's skills folder).
name
changelog-writing
description
写或修改 CHANGELOG.md(待发布条目、版本亮点段、GitHub Release 说明)时使用。含按改动性质分组落位、中英双语体例、发版前的两道门禁(三处版本号同步 + 亮点段抽取会 fail-fast)与写后自检命令。

CHANGELOG 写作(dsh-config-manager)

这份 changelog 是发布说明的唯一来源:打 tag 时 CI 直接抽取当前版本段当 GitHub Release 描述。 所以它既要给人读,也要能被机器切段 —— 写错位置、写错版本号、漏写当前版本段,都会在发版那一刻变成红灯或一条错误的发布公告。

本 Skill 只规定落位、体例与自检;具体改哪些功能、有没有发布权限由当前任务决定。

何时使用 / 何时跳过

用:

  • 用户可见的变化(新功能 / 行为变更 / 修复 / 移除 / 安全)准备写进 CHANGELOG 时。
  • 发版前补「当前版本亮点段」时。

跳过:

  • 只改注释、重构、内部测试且用户可感知行为没变(这类不写条目;没把握就问一句)。
  • 纯文档改动(除非它改变了用户的操作方式)。

1. 落位:写进哪一段

  • 文件 = 仓库根 CHANGELOG.md,格式遵循 Keep a Changelog。

  • 未发布的内容一律写进 ## [Unreleased],按改动性质分组,顺序固定:

    分组放什么
    ### 🆕 新增 · Added新功能、新来源、新通道、新入口
    ### 🔧 变更 · Changed行为/口径改变、原本静默的变可见、性能与体验变化
    ### 🐛 修复 · Fixed修 bug、修误报、补护栏
    ### 🗑️ 移除 · Removed删功能(有内容才写这个标题)
    ### 🔐 安全 · Security安全修复(有内容才写这个标题)
  • 没有内容的分组不写标题;分组内的条目之间空一行;分组之间空一行。

  • 已发布的历史版本段保留当时写法,不回改(那 40 多个版本段是发布记录,整批重排只会产生巨大无意义 diff)。用户明确要求时才动。

  • 分组标题下的子条目如果本来有自己的小节标题,用 ####(比分组低一级)。

2. 体例:一条条目怎么写

  • 中英双语,两种写法都算合规(同一条目内):
    • 段落式:中文块(> **中文标题**…)在前,英文块(> **English title**…)紧随,中间空行 —— Unreleased 段常用;
    • 行内式:一条 bullet 里先中文、后英文加粗点 —— 已发布段常用。
  • 标题用加粗块,不用 ### 顶掉分组:> **中文标题**:一句话说清症状/变化。
  • 每条尽量带:症状 → 根因 → 改法 → 护栏(哪个测试/脚本钉住)→ issue 编号((issue #75))。
  • emoji 可选:分组标题必须带(见上表);条目内可用(🔌 🧩 🐛 🔐 等本仓已有用法)。
口径纪律(本仓最看重的一条)
  • 不得夸大:没做的写没做 ——「只报不修」「真机未逐家验证」「本轮收益为零」「未验证(unavailable 不算验证成功)」都要如实写。
  • 不把计划写成已完成:还没合并/还没验证的东西不进 changelog。
  • 不承诺未发布的版本号:发版前不写「将在 v0.1.x 修复」。
  • 数字要带口径:写清是哪个快照、哪台机器、什么时间(例:(2026-10-06 真机快照:units 1195))。
  • 证据要可复现:点名测试文件 / 复核脚本 / 命令。

3. 发版时才做(不是现在)

两道门禁,漏一条 CI 直接 fail:

  1. 三处版本号同步:package.json.version ≡ src/index.ts 的 PLUGIN_VERSION ≡ package-lock.json 的根对象与 packages[""].version。 守卫 = tests/packaging-contract.test.ts 的 V-1(源码级正则,任一处漏改即 npm test 红灯)。
  2. 在文件顶部加当前版本段:## [X.Y.Z] - YYYY-MM-DD,正文是本版本的中英双语亮点。 CI 用 .github/scripts/extract-release-notes.py 从 ## [X.Y.Z] 切到下一条 ## (### 子分组原样进发布说明);抽不到或为空 → fail fast 拒绝发版。

不发布的时候:不要 bump 版本号、也不要写 ## [X.Y.Z] 段 —— 内容留在 ## [Unreleased](版本号 = 最近已发布的版本)。

4. 写后自检(必须做)

bash
# ① 结构与分组(Unreleased 段应当只有「有内容」的分组标题)
grep -nE '^### |^#### ' CHANGELOG.md | head -20          # bash
Select-String -Path CHANGELOG.md -Pattern '^### |^#### ' # PowerShell

# ② 中英配平:中文块与英文块数量应当一致(段落式体例)
grep -c '^> \*\*' CHANGELOG.md

# ③ 发版前:本地跑一次抽取,确认当前版本段非空(这一步就是 CI 的门禁)
python3 .github/scripts/extract-release-notes.py "$(node -p 'require("./package.json").version')" CHANGELOG.md | head -20

自检不通过就别宣布完成:宁可让用户看见「还差一段」,也不要让 CI 在打 tag 时才发现。

5. 常见错误

错误后果正确做法
新条目直接写 ## [X.Y.Z] 段版本号没 bump 就对不上;发版时又得搬一次未发布一律写 ## [Unreleased] 的对应分组
修复写进「新增」、变更写进「修复」发布说明误导读者按第 1 节的分组表落位
空分组也留标题发布说明里全是空壳没内容就不写那个标题
只写中文或只写英文本仓 changelog 是双语的中英成对写
把「计划做」写成「已做」失信;读者按它决策只写已合并、已验证的变化
顺手回改历史版本段巨大无意义 diff,且改动已发布的记录只动 ## [Unreleased](用户明确要求除外)
改了分组约定但只改代码约定漂移三处一起改:CHANGELOG.md 头部「条目落位」、本 Skill、必要时 DEVELOPERS.md §自动发布

© xiajiajun516, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .dsh/skills/changelog-writing of xiajiajun516/dsh-config-manager.

Open the folder on GitHubat commit 34092a5

Compare with similar skills

Changelog Writing next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Changelog Writing compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Changelog Writing this skillxiajiajun516/dsh-config-manager172—~805Automated safety check: PassMIT
Rea Changelog Updatemorluto/rea80k—~1.9kAutomated safety check: PassMIT
Plane Release Notes Generatormakeplane/plane61k—~2.5kAutomated safety check: PassAGPL-3.0
Deepseek Automationzhu1090093659/deepseek-pp1.9k—~2.1kAutomated safety check: NotesApache-2.0
Release Prepjohnhuang316/code-index-mcp1k—~680Automated safety check: PassMIT
Store Submitzhitongblog/solomd1.2k—~1.7kAutomated safety check: NotesMIT

Similar skills

  • Prepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization.

    80k GitHub stars~1.9k tokensUpdated today
    DevelopmentAuto-check passed
  • Builds categorized release notes for a Plane release pull request from its commits and writes them into the PR description, for both the plane-cloud and plane-ee repos.

    61k GitHub stars~2.5k tokensUpdated yesterday
    DevelopmentAuto-check passed
  • Deepseek Automation

    zhu1090093659/deepseek-pp

    A skill your agent uses when implementing, resuming, reviewing, or verifying the DeepSeek++ Codex-style automation feature in this repository.

    1.9k GitHub stars~2.1k tokensUpdated 1 mo ago
    DevelopmentAuto-check: notes
  • Release Prep

    johnhuang316/code-index-mcp

    A skill your agent uses when code-index-mcp implementation is complete and a version bump, release notes, tag, package publication, or GitHub release is being prepared.

    1k GitHub stars~680 tokensUpdated 2 mo ago
    DevelopmentAuto-check passed
  • Store Submit

    zhitongblog/solomd

    Publish a SoloMD release to the stores that have no usable submission API — Google Play Console and Microsoft Partner Center — by driving them through the local Unzoo Browser REST API.

    1.2k GitHub stars~1.7k tokensUpdated yesterday
    DevelopmentAuto-check: notes
  • Release

    yoanbernabeu/grepai

    Create a new release for grepai. An agent skill from yoanbernabeu/grepai.

    1.9k GitHub stars~918 tokensUpdated 20 days ago
    DevelopmentAuto-check passed

Categories

Questions about Changelog Writing

What does Changelog Writing do?

写或修改 CHANGELOG.md(待发布条目、版本亮点段、GitHub Release 说明)时使用。含按改动性质分组落位、中英双语体例、发版前的两道门禁(三处版本号同步 + 亮点段抽取会 fail-fast)与写后自检命令。. Changelog Writing is an agent skill from xiajiajun516/dsh-config-manager.

When should I use Changelog Writing?

Changelog Writing fits situations like: tasks that involve Changelog and release notes.

How do I install Changelog Writing in Claude Code?

Run `npx skills add xiajiajun516/dsh-config-manager --skill changelog-writing -a claude-code`. Or copy the skill folder (.dsh/skills/changelog-writing in xiajiajun516/dsh-config-manager) into .claude/skills/changelog-writing in your project. Claude Code loads it when a task matches its description.

How do I install Changelog Writing in Codex?

Run `npx skills add xiajiajun516/dsh-config-manager --skill changelog-writing -a codex`. Or copy the skill folder (.dsh/skills/changelog-writing in xiajiajun516/dsh-config-manager) into .agents/skills/changelog-writing in your project. Codex loads it when a task matches its description.

Can I use Changelog Writing in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add xiajiajun516/dsh-config-manager --skill changelog-writing -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/changelog-writing, .gemini/skills/changelog-writing, .github/skills/changelog-writing and .opencode/skills/changelog-writing in your project.

What does Changelog Writing need to run?

Going by SKILL.md and its folder, Changelog Writing needs the command-line tools its instructions call (python3, node and npm). Our summary lists: Python 3.

Does Changelog Writing access the network?

SKILL.md names 1 domain. As links in the text: keepachangelog.com. This is read from the text; nothing was executed.

Is Changelog Writing safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Changelog Writing use?

Changelog Writing is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Changelog Writing use?

About 805 tokens (SKILL.md is roughly 3.2k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Changelog Writing?

Skills that share tags, products or a category with Changelog Writing: Rea Changelog Update (morluto/rea, 80k stars), Plane Release Notes Generator (makeplane/plane, 61k stars), Deepseek Automation (zhu1090093659/deepseek-pp, 1.9k stars) and Release Prep (johnhuang316/code-index-mcp, 1k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Changelog Writing?

xiajiajun516 (a GitHub user) maintains it in xiajiajun516/dsh-config-manager, which has 172 GitHub stars. The repository was last updated on October 8, 2026.

Source: xiajiajun516/dsh-config-manager on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.