插件开发范式
插件提交检查
按改动确认契约、调用方和验证证据;只展开相关领域。
完成修改时按下面的实际影响核对。不需要为一个日志改动通读依赖、数据库和页面教程。
| 改动 | 审查问题 | 最小有意义证据 |
|---|---|---|
| 依赖、后台任务、资源 | owner 和清理是否明确;停止后还能否调用 | required/optional 路径、失败初始化与停止回收;依赖、清理 |
| Part 与配置 | 声明路径是否稳定;保存和应用是否区分 | 默认/非法输入、更新结果与 cleanup;配置、Part |
| API 与错误 | 调用者能否恢复;返回的是快照还是需释放的资源 | 成功、失败及跨边界真实传递;契约 |
| 日志 | 人读值与查询字段是否分开;昂贵值是否 lazy | 原始 Error、身份与 disabled 行为;日志 |
| 并发、取消与重试 | 是否只取消等待;重复执行是否安全;额度何时释放 | 并发、取消、失败收尾;Async |
| HTTP、命令或数据 | 输入由谁校验;资源和副作用由谁拥有 | 从公开入口覆盖成功/拒绝/停止;网络边界用真实 listener |
| Workbench | 页面关闭是否释放订阅;关闭整个 UI 后业务是否独立 | 读取/操作/关闭及无 Workbench 路径;页面资源 |
| 发行契约 | exports、peers、声明与实际制品是否一致 | 独立安装或搬离工作区验证;插件包 |
运行所属包实际声明的检查;发布前按项目要求执行完整 verify 与构建。纯函数用普通测试,插件行为用隔离 host,当前运行状态用dev console。
交付说明写清修改后的行为、已执行检查及未验证边界。用户用法变化更新所属指南;删除契约时同步删除旧入口和调用方,不让多个页面继续维护不同版本的写法。
最后更新于