Skip to content

开发总览 ​

面向要改这个平台代码的人:先搭环境,再看懂仓库结构与规约,然后会跑测试、能加服务或业务域。本篇是入口与速查,命令与 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                                     # 提交信息模板见 conventions

CI 的 PR 全量预算小于 15 分钟,不要把 CI 当本地编译器。

质量门禁速记 ​

门值强制点
unsafe_codeforbidworkspace lints(根 Cargo.toml)
clippy alldeny + -D warnings流水线 lint 关卡
认知复杂度≤10clippy.toml
函数参数≤7clippy.toml
行宽100rustfmt.toml
行覆盖≥80%覆盖率关卡 --fail-under-lines 80
测试离线全绿测试关卡;基线随代码演进,以 cargo test --workspace 实测为准
proto零破坏性变更契约关卡(buf breaking)
供应链cargo-deny 通过依赖审查关卡
迁移已合入即冻结迁移纪律(见编码规约)

常用入口 ​

相关页面 ​

以仓库代码为事实源构建 · RC Hardening 阶段