37 lines
2.3 KiB
Markdown
37 lines
2.3 KiB
Markdown
# Contributing
|
|
|
|
Read [AGENTS.md](AGENTS.md) for the task-manual index and safety boundaries. Install the locked
|
|
runtime using [Setup](docs/SETUP.md), then run `./scripts/check`. The GitHub core/layout job does
|
|
not provision CUDA and is not a substitute for the GPU setup/robot/pipeline gates.
|
|
|
|
## Where changes belong
|
|
|
|
- `src/universal_humanoid/`: first-party CLI, task adaptation, evaluation and operations.
|
|
- `src/universal_humanoid/robot_specs/`: independently reviewed robot conformance expectations.
|
|
- `experiments/`: bounded, explicit experiment recipes; no automatically launched long training.
|
|
- `rl/mjlab/`, `rl/rsl_rl/`: reviewed vendored dependencies, not a place to scatter routine task changes.
|
|
- `.agents/skills/`: stage manuals; index every new manual in `AGENTS.md`.
|
|
- `docs/`: public setup, architecture, interface contracts and validation records.
|
|
- `tests/`: core, adapter, negative conformance, provenance, telemetry and layout regression checks.
|
|
|
|
## Required checks
|
|
|
|
`tests/test_layout.py` requires the CLI table to match parser commands/options, robot check IDs
|
|
to match their documentation, every skill to be indexed, links to resolve, backend packages and
|
|
licenses to be present, and vendor inventory/portable path rules to hold. Update code and its
|
|
manual together; do not weaken a test just to avoid maintaining documentation.
|
|
|
|
For a robot change, follow [NEW_ROBOT.md](docs/NEW_ROBOT.md), including negative tests and actual
|
|
contact/control probes. For a backend change, follow [VENDOR.md](docs/VENDOR.md), retain modification
|
|
notices and licenses, review inherited patches, and regenerate the vendor inventory deliberately.
|
|
Dependency changes require a reviewed `uv.lock` and refreshed hashed pip export.
|
|
|
|
Report the exact configuration, source/asset identity, runtime, commands, outputs and observed
|
|
failures. Distinguish static/unit success, physics/interface conformance, policy quality and ONNX
|
|
parity. Never claim hardware safety from simulation or submit credentials, environments, logs,
|
|
private asset files or unreviewed source archives.
|
|
|
|
Original project code and documentation use [Apache-2.0](LICENSE). Intentionally submitted
|
|
contributions follow its contribution terms unless explicitly stated otherwise. Retain third-party
|
|
copyright/license notices and do not relicense bundled dependencies or assets.
|