mcpField
C
changelog

changelog

github.com/chrisbanes开发1.2k115 次安装今天更新
代码仓库

关于 changelog

changelog 是指导 Agent 维护和审查变更日志的技能,适用于版本记录整理。它强调依据已核实的变更、保留既有文字,并检查链接、署名与覆盖范围。

主要功能

  1. 01确定版本范围与比较基线
  2. 02核对变更记录及相关证据
  3. 03补充用户可见变更和迁移说明
  4. 04验证引用链接与贡献者署名
  5. 05检查差异并报告验证结果

适用场景

  1. 01整理 Unreleased 变更记录
  2. 02准备指定版本的发布说明
  3. 03只读审查变更日志覆盖情况

安装

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

$npx skills add https://github.com/chrisbanes/skills --skill changelog

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

附带文件references/stable-release.md

详细介绍

更新日志

核心原则

确保面向用户的说明完整,并以已验证的变更为依据,同时保留经过整理的措辞和已发布的历史记录。

流程

  1. 确定请求的范围、仓库约定、变更日志路径和 Git 状态。选择未发布版本维护或指定版本说明;审查时保持只读。如果用户将工作限制在所提供的状态内,则不要运行任何探查命令,并将未提供的事实标记为未知。此技能适用于各种语言和发布系统;不需要 Kotlin 插件、凭据、API 快照或发布审批。 如果不存在变更日志,且未明确要求创建,则说明已跳过并结束。若明确要求创建,则先确定其格式和历史范围。
  2. 根据仓库的标签约定和提交祖先关系,或所提供的证据,确定比较范围。对于未发布版本维护,与最新的适用版本比较,并保留仓库的增量式预发布基线。对于指定版本说明,使用所提供的目标版本;如果目标缺失或存在歧义,则在编辑前先确定。对于指定的预发布版本,保留从前一个适用版本开始的仓库增量式基线。保持当前预发布周期完整展开。最终版本应以之前的稳定版本作为整个周期的基线,而不只是最近的候选版本差异;首个稳定版本应覆盖从项目开始以来的历史。遇到有歧义的标签时,应先厘清,不要仅按字典序选择最高标签。未发布版本维护无需设置下一个开发版本。
  3. 将现有说明与范围内的完整历史、差异以及相关问题/PR 证据进行比较。保留准确且经过整理的措辞;补充遗漏的用户可见变更,纠正不准确之处,并省略仅限内部的变更。仅将引用和署名附在描述相应变更的条目上;尚未涵盖的变更应单独列出。纳入相关的重大变更和迁移指南。若无法确定覆盖情况,应查明并报告具体缺口,不要虚构声明或声称内容完整。对于最终稳定版本,编辑前应完整阅读稳定版本说明,并遵循其中的覆盖范围和历史处理流程。
  4. 验证链接和署名。对于每项有 PR 佐证的变更,直接将其编号链接到规范的拉取请求 URL,例如 [#123](https://github.com/OWNER/REPO/pull/123)。在适当情况下,使用明确的 Markdown URL 链接对应的问题;仅写数字是不够的。对于经核实的非维护者 PR 作者,应将其已核实的姓名或用户名链接到其 GitHub 个人资料。根据 PR 确认作者身份,并依据仓库证据确认维护者身份。所提供的事实可作为证据;仅在事实缺失且获准访问时查询提供方。报告无法验证的 URL、作者身份或维护者身份,以及已确认的非维护者缺少个人资料 URL 的情况。维护者无需个人资料署名。除按要求添加链接和署名外,保留准确且经过整理的文本;绝不要虚构身份或分类。
  5. 仅进行获授权的变更日志编辑。未发布版本维护应保留在现有标题下。对于指定版本说明,遵循仓库的标题、日期和锚点约定;仅在收到请求时才定稿标题。如果由 release-kotlin-library 调用,除非调用方明确要求仅定稿变更日志,否则将标题定稿留给其发布助手处理。将 Git 修改(包括拉取和提交)、版本文件、快照和发布留给调用方处理。变更日志可供审查,并不代表获准执行这些操作。
  6. 检查实际差异,确认其与已审查的变更一致,验证引用位置并确认已发布历史得到保留;在允许执行命令时运行 git diff --check。如果仓库说明要求验证文档,或格式变更需要验证,则使用仓库的文档验证流程;若无法执行验证,应予以报告。仅检查标题无法确认语义上的完整性。

完成门槛

展示实际说明或可直接审阅的差异、比较基准和审阅范围、已执行的验证,以及尚未解决的证据或覆盖缺口。 对于只读审阅,展示发现或拟议说明,不要声称已进行编辑。 对于缺少变更日志的情况,报告跳过了该步骤,不要声称已完成对照整理。 对于最终发布,在声称说明完整之前,先确认覆盖范围台账中的每一条保留记录都出现在稳定版摘要中,且原始预发布历史保持完整。适用时,将这些结果交给调用方发布工作流;其余发布门槛和审批由调用方负责。

评论

支持 Markdown