工具与验证
本页将 .github/prompts/tooling.prompt.md 转换为面向贡献者的说明文档。如果你需要搭建仓库、运行包,或者在提交评审前验证改动,应从这里开始。
环境准备
LAV2 需要 Python 3.11 或更新版本。本地仿真路径依赖 MuJoCo,而 GPU 驱动只在 Torch 或其它需要 GPU 的模拟器后端中才相关。
安装命令请参考专门的 安装 页面。本页关注的是环境已经就绪之后的工作流。
主要入口
标准的本地 runner 入口有:
lav2
uv run lav2
uv run -m lav2.controller
当你希望在日志或调试会话中保留明确入口形式时,优先使用模块方式。
质量检查
推荐使用 prek 的 hook 工作流:
uv run prek install
uv run prek install --hook-type commit-msg
uv run prek run --all-files
备用方案是 Python pre-commit:
pre-commit install --hook-type commit-msg
pre-commit install
pre-commit run --all-files
提交评审前
在请求 review 之前:
- 让改动范围保持在当前 Backlog 任务内
- 在任务备注中记录开放问题、风险与验证结果
- 当行为发生变化时,运行相关 hooks,并至少做一次运行时健全性检查
- commit message 使用 Conventional Commit 风格:
type(scope): subject
健全性检查
如果要做本地行为检查,使用交互式 runner:
uv run lav2
- 选择模式
0检查旋翼飞行栈 - 选择模式
1检查履带栈 - 重点观察 NaN、执行器饱和或资产缺失错误
如果要验证 Isaac Lab 集成,请确保训练或回放脚本中导入了 lav2.tasks.isaaclab,然后传入类似 --task Isaac-LAV2-Base-Direct-v0 的任务名。
何时更新本页
只要 .github/prompts/tooling.prompt.md、安装命令、入口命令或验证命令发生变化,就应更新本页。prompt 文件仍然适合 agent 使用,但对人类贡献者来说,本页应是更可读的事实来源。