参与贡献
开发环境、质量门禁、贡献方向,以及适配器与运行器的契约要求。
开发环境#
: <<'PUBLIC_REPOSITORY_PENDING'
# 公开源码仓库尚未上线;以下开发流程当前不会执行。
git clone https://example.invalid/anchor.git
cd anchor
python -m venv .venv && source .venv/bin/activate
python -m pip install -e '.[dev]'
pytest -q
ruff check .
ruff format --check .
python ci_checks/run_static_checks.py
python scripts/smoke_package.py
PUBLIC_REPOSITORY_PENDING发行名是 anchor-framework,导入包名是 anchor_eval,命令行入口是 anchor。打包冒烟测试会同时构建 wheel 与 sdist,把它们分别装进独立虚拟环境,并用一条真实的因果轨迹去驱动已安装的 CLI。
从哪里开始贡献#
| 方向 | 适合谁 | 说明 |
|---|---|---|
| 新增只读适配器 | 熟悉某个基准 / 数据格式的人 | 把一个新的基准家族的原生输出映射成规范因果步。必须只读,且必须保留原生语义。 |
| 分析插件 | 做指标 / 统计 / 图分析的人 | 在 RunBundle 与 trace 之上做图与数学分析,不写基准专用执行代码。 |
| 任务图建模 | 熟悉某类操作任务的人 | 为一个新任务写规范任务图与阶段契约(P0–P4 之类的里程碑定义)。 |
| 故障指纹库 | 做评测与诊断的人 | 把新的失败模式补进故障分析手册,附可复现的 run id。 |
| 文档与本地化 | 所有人 | 本文档站的中英文内容位于站点仓库 app/documents/,结构对齐,缺翻译会是类型错误。 |
| 前端与可视化 | 前端 / 数据可视化 | 任务图渲染、时间轴、实时流的性能与可访问性。 |
合入标准#
- 只读优先:适配器永远不写上游目录。
- 证据可溯源:任何新指标要说明单位、方向、作用域与失败时的行为。
- 失败也要可诊断:新代码路径在失败时必须留下能被诊断的产物,而不是异常栈加一地临时文件。
- 不引入静默兼容:宁可报告不匹配,也不要偷偷修正数据。
- 测试:
pytest -q、ruff与静态检查必须通过;涉及打包的改动要跑打包冒烟。
契约文档#
- 架构:
docs/architecture.md - 适配器契约:
docs/adapter-contract.md - RoboDojo Runner v1 契约:
docs/robodojo-runner-contract.md - 轨迹评测策略(证据门禁、公式、聚合规则与尚未实现的度量):
docs/trajectory-evaluation.md - CI、交付物与 rubric 检查:
docs/ci-and-rubrics.md - RoboDojo PR 命令(权限、密钥、回执与已核验奖励语义):
docs/robodojo-pr-commands.md
文档修订 · 2026-08-26 · 文档源码位于 app/documents/;公开仓库链接待上线。