3.5 KiB
Public release checklist
A public repository description should explain the reusable framework, not assume access to a maintainer's workstation. Documentation portability and executable portability are separate tasks. This checklist records what is still needed before describing the project as a reproducible, ready-to-install release.
Packaging and dependencies
- Include backend copies, required G1/T1 adapters/assets, source inventories and license notices; see
VENDOR.md. - Publish
uv.lock, its hashed pip export and reference CUDA/platform guidance. - Remove personal workspace defaults from launchers, T1 and asset discovery.
- Reject bad explicit interpreter paths and legacy external-backend overrides.
- Install the lock in a new project environment without the external backend environment.
- Test a relocated checkout/new environment from another working directory, plus wheel resource parity and installed T1 conformance; see
PORTABILITY_VALIDATION.md. - Independently validate additional machines/GPUs and any additional platform-specific lock.
- Document bundled model variants/licenses and explicit optional external overrides.
Repository presentation
- Use audience-neutral English and Chinese introductions and configurable-path command examples.
- Distinguish architectural goals, implemented features, reference validation and unsupported capabilities.
- Document setup requirements and current distribution limitations.
- Add Apache-2.0 for original code, retain third-party licenses, and include license texts in package metadata.
NOTICE.mdremains attribution, not a replacement license. - Set the actual repository URL and package metadata when hosting is established; do not publish placeholder links as real project URLs.
- Add contribution guidance, stage manuals, synchronization tests and core/layout CI configuration.
- Configure a GPU CI runner and hosted issue templates when the repository is published.
Suggested GitHub repository description:
An agent-ready framework for modular humanoid reinforcement learning with mjlab and MuJoCo Warp: reward iteration, training, evaluation, replay, and ONNX export.
Suggested topics: humanoid-robotics, reinforcement-learning, mujoco, mjlab, robot-learning,
ai-agents, sim-to-real (research direction, not a claim of hardware deployment support).
Artifacts, privacy and claims
- Inspect the actual files staged for publication. Ignore rules do not remove files already tracked by Git.
- Exclude credentials,
.env, virtual environments, proprietary meshes and unlicensed third-party files. - Review run manifests, logs and archives for usernames, absolute paths, git status and source licensing before sharing them as release assets.
- Do not present development-only
runs/paths as downloadable artifacts unless those artifacts have actually been published. - Separate successful pipeline execution from policy convergence; include failed episodes and evaluation protocol details.
- Preserve
hardware_approved: falseand the absence of a physical robot execution interface.
Release validation
Run lint/unit tests, selected adapter tests, GPU smoke, bounded training, fixed-protocol evaluation, video recording and ONNX parity in the documented release environment. Record commit and dependency identities alongside measured evidence. Existing historical validation is useful context, not a substitute for verifying the released revision on a clean installation.