关于 release-notes
面向开发者的发行说明整理技能,依据代码库历史确定变更范围,并从提交和差异中收集证据,生成面向读者的说明,不虚构内容。
主要功能
- 01确定并核实发行范围
- 02审查提交记录与完整差异
- 03区分用户变更与内部维护
- 04标明迁移要求与破坏性变更
- 05附上稳定的问题引用
- 06避免无依据的发行声明
适用场景
- 01编写标签版本之间的发行说明
- 02总结升级要求与弃用事项
- 03面向发行读者记录变更
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ jmerta/ codex-skills --skill release-notes安装后在 Claude Code 中输入/release-notes确认已加载。
附带文件agents/openai.yamlreferences/release-notes-template.md
详细介绍
发布说明
确定范围
- 阅读仓库的发布约定,确定版本、受众以及确切的
from_ref..to_ref范围。 - 在明确无歧义时,根据可达标签推导上一版本。若存在多个发布分支,或目标未知导致范围存在实质性歧义,请先询问再继续。
- 验证两个引用并记录其 SHA。若有确切范围可用,请勿使用日期窗口。
收集证据
- 使用第一父级历史识别达到发布规模的变更,然后检查完整提交列表和差异,避免遗漏压缩、变基和直接提交。
- 优先使用仓库连接器获取关联 PR 和 issue 的元数据;若不可用,则使用托管平台 CLI 或本地 Git 作为后备方案。
- 阅读与配置、API、架构、迁移、依赖项、运行时、部署和安全相关的差异。不要仅凭标题推断影响。
- 区分用户可见的变更与内部维护,并省略对目标受众没有帮助的噪声。
撰写并验证
- 开篇说明有哪些变化及其重要性。
- 明确说明破坏性变更、前置条件、数据或配置迁移、弃用、安全修复、已知问题和回滚限制。
- 如有稳定的 PR 或 issue 引用,请一并提供。
- 省略空章节。切勿捏造验证结果、issue 链接、兼容性声明或发布日期。
- 交付前重新检查范围、差异统计信息以及任何迁移或升级说明。
将 references/release-notes-template.md 作为可选内容清单,而非必须包含所有标题的要求。发布标签或托管版本需要另行明确授权。
评论
支持 Markdown