项目维护
2026/7/20大约 3 分钟项目维护发布文档验证
项目维护
本节面向贡献者和发布维护者。所有版本、API、文档和验证结论都应能回到仓库中的单一来源,避免手工复制形成漂移。
按任务进入
理解仓库架构与责任边界确认 packages、apps、docs、vectors 各自承载什么,以及禁止的反向依赖。发布制品版本与发布流程同步 npm、Maven、tag、变更记录和版本化 API Reference。更新站点文档构建与部署生成 TypeDoc/Javadoc,执行页面、链接、示例和部署产物检查。增加能力扩展包接入契约定义制品隔离、目录登记、说明书、测试证据和版本快照要求。
发布前最短路径
- 阅读架构说明,确认变更位于正确的包和目录。
- 公共 API 变化先更新源码注释、语言说明书、覆盖映射和可执行示例。
- 执行发布流程中的定向检查。
- 用发布精简清单核对版本、制品内容和变更记录。
- 按文档构建与部署生成不可变 Reference 并验证站点。
验证与证据
- 性能与基准:怎样复现实测数据。
- 性能优化方法:怎样在不改变协议语义时优化。
- 当前支持范围:当前制品、平台和能力边界。
- 验证模型:单元测试、固定向量、互操作和外部实现各能证明什么。
- 安全保证边界:哪些结论不能由测试推出。
- SM2 兼容策略:密文、签名、公钥与身份字段的兼容原则。
维护文档中的命令必须能在仓库中执行。性能数字需要关联可复现 benchmark;标准结论需要关联标准编号或固定 reference;内部互操作向量不能标成外部标准向量。