module-boundaries.md
650 Bytes
Module Boundaries
原则:共享接口,不共享内部实现。
可以放到公共仓库的信息
- 模块输入输出字段
- API / 协议 / 数据格式
- 错误码和状态码
- 版本兼容策略
- 跨模块性能约束
- 集成测试要求
- 对外可共享的领域知识
不应放到公共仓库的信息
- 算法核心实现逻辑
- 模型参数、训练数据、实验记录
- 私有源码和未公开补丁
- 模块内部敏感设计
- 只属于单个团队的调试记录
跨模块协作规则
跨模块变更应先更新 20_interfaces/ 中的接口文档,确认后再分别进入各模块代码仓库实现。