外观
开发总览
面向要改这个平台代码的人:先搭环境,再看懂仓库结构与规约,然后会跑测试、能加服务或业务域。本篇是入口与速查,命令与 CI 门禁逐条对齐(第一天到第一周的完整路线按本册各页顺序读即可)。
阅读顺序
text
1. setup 装工具链(1.96 日常 + 1.80 MSRV)与可选工具
2. project-structure 仓库地图:25 个 workspace 成员怎么分工
3. conventions 硬门禁、模块头与注释规约、错误码分段、宏与表驱动
4. testing 离线 / live / 性质 / 基准四层测试体系
5. new-service 接入一个新部署单元的六步配方
6. new-domain 在既有服务内挂一个业务域(六件套)
7. ci CI 关卡全景:门禁怎么读、怎么本地复现提交流(最小自检面)
bash
cargo fmt --all -- --check
cargo clippy --workspace --all-targets -- -D warnings
cargo clippy -p svc-gateway --features mq-nats --all-targets -- -D warnings # 加其余五个 nats 面
cargo test --workspace # 离线全量,全绿为准(数字以实测为准)
# 动到 proto / openapi / migrations / chart 时,追加对应 buf、live、helm 校验
git commit # 提交信息模板见 conventionsCI 的 PR 全量预算小于 15 分钟,不要把 CI 当本地编译器。
质量门禁速记
| 门 | 值 | 强制点 |
|---|---|---|
unsafe_code | forbid | workspace lints(根 Cargo.toml) |
clippy all | deny + -D warnings | 流水线 lint 关卡 |
| 认知复杂度 | ≤10 | clippy.toml |
| 函数参数 | ≤7 | clippy.toml |
| 行宽 | 100 | rustfmt.toml |
| 行覆盖 | ≥80% | 覆盖率关卡 --fail-under-lines 80 |
| 测试 | 离线全绿 | 测试关卡;基线随代码演进,以 cargo test --workspace 实测为准 |
| proto | 零破坏性变更 | 契约关卡(buf breaking) |
| 供应链 | cargo-deny 通过 | 依赖审查关卡 |
| 迁移 | 已合入即冻结 | 迁移纪律(见编码规约) |
常用入口
- 源码导航:源码地图(半天路线)
- 契约工作流:gRPC 契约(buf 纪律)
- 配置开发:配置装载
- 平台 crate 清单:platform crates
相关页面
- 本地开发工作流(日常回路)
- 扩展开发三路:插件 SDK / 接入一个新服务 / 在既有服务内接入新业务域