跳转至

开发指南

本节说明仓库中的开发工作如何组织,以及实际的操作性说明分别位于哪里。

建议阅读顺序

  1. 开发规范 说明项目级工程约定,包括贡献者工作流、模块设计、依赖管理和文档维护要求。
  2. 工具与验证 说明环境准备、CLI 入口、质量检查和基本 sanity check 所需的实际命令。它是 .github/prompts/tooling.prompt.md 的文档化版本。
  3. Backlog 与内部文档 说明如何使用 Backlog.md 管理计划内工作,以及如何阅读 backlog/docs/ 下的开发者导向资料。

仓库关键位置

  • lav2/:控制器、动力学、轨迹、任务与运行辅助代码所在的包源码
  • lav2/assets/:MuJoCo MJCF、网格与 USD 资产
  • scripts/:不同后端启动流程的轻量包装脚本
  • .github/prompts/:贡献者与编码代理使用的操作性提示
  • backlog/:项目规划、里程碑、任务与内部参考文档

工程约定

项目级贡献者约定已统一收敛到 开发规范。该页集中说明了工作流要求、模块设计、依赖管理、导出策略、文档维护,以及仓库范围内需要保持一致的接口约束。

本指南的范围

本节页面刻意聚焦开发工作流,而不是实现理论。它们将过去散落在 CONTRIBUTING.md.github/prompts/backlog/docs/ 中的操作性内容整理到了统一位置。