mcpField
D
docs-changelog

docs-changelog

github.com/petekp开发1039 次安装21 周前更新
代码仓库

关于 docs-changelog

docs-changelog 是一项文档技能，可根据最近的提交撰写符合 Keep a Changelog 格式的分类更新，并指导用户查找文件、确定版本和检查结果。

主要功能

  1. 01查找常见位置的变更日志文件
  2. 02解析最新版本号和日期
  3. 03审阅提交并分类变更
  4. 04按 Keep a Changelog 格式撰写条目
  5. 05检查条目顺序和版本链接

适用场景

  1. 01根据近期提交起草版本条目
  2. 02将变更整理为标准类别
  3. 03检查变更日志格式和链接

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/petekp/agent-skills --skill docs-changelog

安装后在 Claude Code 中输入/docs-changelog确认已加载。

详细介绍

文档更新日志

通过查看上次记录的条目之后的提交，对变更进行分类，并按照 Keep a Changelog 格式追加一条撰写完善的条目。

工作流

1. 查找更新日志文件

在常见位置搜索更新日志：

CHANGELOG.md
changelog.md
docs/changelog.md
docs/CHANGELOG.md
src/pages/changelog.md
src/content/changelog.mdx
content/changelog.md

如果在标准位置找不到，请使用 glob 和 **/changelog.{md,mdx}、**/CHANGELOG.{md,mdx} 等模式搜索。如果找到多个候选文件，请询问用户要使用哪一个。

2. 解析最新条目

读取更新日志文件并提取最新的版本标题。标题格式如下：

## [X.Y.Z] - YYYY-MM-DD

提取：

  • 版本号（例如 1.2.0）——用于确定下一个版本
  • 日期（例如 2025-01-15）——用于限定 git log 的范围

如果更新日志为空或只有 [Unreleased] 标题，则使用仓库最早的标签或首次提交作为边界。

3. 收集提交

运行：

git log --oneline --no-merges --after="YYYY-MM-DD" HEAD

其中 YYYY-MM-DD 是更新日志最新条目的日期。还要检查标签：

git tag -l --sort=-creatordate | head -5

如果有比更新日志最新条目更新的标签，则将其用作新版本号。否则，询问用户此条目应使用哪个版本号。

4. 对变更进行分类

查看每个提交，并将其归入 Keep a Changelog 中的某个类别：

类别适用内容
Added新功能、新页面、新 API 端点
Changed现有功能的更新、行为变更、依赖项更新
Deprecated已标记为将来移除的功能
Removed删除的功能、移除的页面、停止支持的内容
FixedBug 修复、拼写错误更正、失效链接修复
Security漏洞补丁、安全性改进

分类规则：

  • 如果提交信息含糊不清，请阅读差异内容——代码才是事实依据
  • 将相关提交合并为一个条目（例如，三次拼写错误修复提交合并为一条“修复文档中的拼写错误”条目）
  • 跳过纯内部提交（CI 配置、lint、仅格式调整），除非它们会影响用户可见的行为
  • 跳过合并提交和版本号更新提交
5. 撰写条目

将新条目插入 # Changelog 标题正下方（如果存在 ## [Unreleased]，则插入其下方）。使用以下确切结构——没有内容的类别部分应省略：

## [X.Y.Z] - YYYY-MM-DD

### Added

- Brief, human-readable description of what was added

### Changed

- Brief description of what changed

### Fixed

- Brief description of what was fixed

撰写规则：

  • 每个项目符号都应为一个句子，并以过去时动词开头（Added、Updated、Fixed、Removed）
  • 面向文档站点的最终用户撰写，而非面向开发者
  • 在有帮助时，链接到相关页面或 PR：Fixed broken link on [Getting Started](/docs/getting-started) page
  • 条目应便于快速浏览——不要使用段落或子项目符号
  • 使用项目现有的语气（查看以往条目并保持一致）
  • 条目日期使用当天日期，除非用户另有指定
6. 验证

写入条目后：

  • 确认条目按时间倒序排列（最新的在前）
  • 如果项目使用版本链接引用，请检查文件底部的引用是否已更新（例如 [1.3.0]: https://github.com/org/repo/compare/v1.2.0...v1.3.0）
  • 阅读最终文件，确保格式整洁

在任务完成前，将新条目提交给用户审核。

评论

支持 Markdown