开发指南
本地验证
./scripts/verify.sh
该门禁会构建 .NET 项目、运行测试、构建 Platform Web、官网和文档站,并检查格式、架构与产品范围。
开发原则
- 先更新契约,再更新 Platform API、数据查询服务、Web 和文档;
- 事件接入只接受强类型
ProductionEvent与InspectionRecord,不让调用方传递任意 SQL 或脚本; - Chat 的统计、权限、工具执行与结果与原始记录核对必须保持确定性;
- 任何新工具都默认只读,并需通过数据范围、结果大小和超时限制;
- 公共文字使用 Ingot Chat,不暴露内部实现术语;
- 新增或改变公开接口时,同步中英文文档、官网和静态文档站测试。
事件契约变更
- 评估事件类型、版本和字段是否保持向后兼容;
- 更新
Ingot.Contracts中的强类型契约和验证; - 追加对应的 API、存储和集成测试;
- 在生产事件规范中记录含义;
- 使用脱敏样本验证 Chat 仍能给出正确限制与相关记录。
文档与官网
docs/ 是中英文内容源。apps/docs-site/ 在构建时读取 Markdown 并生成导航、搜索索引和静态页面。apps/website/ 是官网。修改后至少执行:
npm --prefix apps/docs-site run build
npm --prefix apps/docs-site test
npm --prefix apps/website run build
npm --prefix apps/website test