SuperAPI AI 工具集

add-changeset

编程与开发

查看项目

更新于 10-16 07:28

技能介绍

用途:为 OpenZeppelin Contracts 的 PR 添加变更日志条目(changeset),适用于新增函数、新合约或扩展、改变输出的缺陷修复、新事件、新错误、新接口 ID 或更严格的要求等用户可见的合约行为变更。

何时跳过:仅改 NatSpec、无可观察影响的内部重构、仅测试或 mock 的改动,以及不改变已发布 contracts/ 的 CI、lint、docgen、依赖升级。不确定时倾向于添加,发布审查者可在打标签前删除文件降级为跳过。

用法:运行 npx changeset add,CLI 会询问严重级别并打开编辑器。级别包括 patch(缺陷修复、gas 优化、无 API 表面变化)和 minor(新合约、新扩展、现有合约的新公共函数);贡献者不产生 major,主版本升级由维护者协调。生成的文件位于 .changeset/,格式为分隔线内写 'openzeppelin-solidity': minor,正文以反引号包裹的组件名开头,后接冒号和一句描述用户可见变化的句子。

格式规则:反引号内首词为受影响的合约、扩展或库(如 ERC20、ERC1155Crosschain、Memory、Governor);使用祈使语气(Add、Fix,而非 Added、Fixed);句末句号可选;不使用项目符号、标题或多段文字,发布流程会逐字拼接。只陈述变化,不写理由或动机;若用户需采取行动(迁移步骤、破坏性重命名、更严格的要求),则改为陈述该行动。当同时涉及多个组件、单一前缀会误导时,可省略前导反引号。

提交后:changeset-bot 的 GitHub 检查会评论确认检测到 changeset;若机器人提示 No Changeset found 且该 PR 本不应有 changeset,可留言说明理由,维护者可应用 ignore-changeset 标签。