Thank you for contributing to NVIDIA NemoClaw. A contribution is ready for review when it makes the smallest complete change, includes appropriate validation, and follows the pull request template. Substantive product, architecture, security, integration, or supported-surface work also requires an accepted scope decision.
All participants must follow our Code of Conduct. Report security vulnerabilities through SECURITY.md, not a public issue.
Start with an existing accepted issue when possible. New contributors can browse good first issues. Search open issues and pull requests before proposing new work.
Use the path that matches your contribution:
- Bug or focused improvement: Open an issue with observable behavior, reproduction evidence, and the desired outcome.
- Larger feature or design: Start a GitHub Discussion so the problem and design can settle before implementation.
- Documentation correction: Open a focused pull request and follow the documentation contributor guide.
- Integration, recipe, custom image, or supported solution: Confirm an accepted product decision before implementation. The product scope gate defines this requirement and the route for independent community solutions.
Before substantive work begins, a maintainer must record the decision, reason, placement, accountable maintainer, and validation plan in the issue or linked discussion. Small documentation corrections and low-risk fixes can proceed directly to a pull request.
Questions also belong in GitHub Discussions or on a related issue.
NemoClaw is under active development. Maintainers review issues, discussions, and pull requests on a best-effort basis; the project does not guarantee response or review times. See Current Priorities for planning context, not a delivery commitment.
Install the prerequisites reported by the contributor doctor, then run the supported setup from the repository root:
npm run dev:setup
npm run dev:doctorThe setup command installs repository-local dependencies, builds and type-checks the CLI and plugin, and installs Git hooks. It does not install host packages, change accounts or global Git configuration, accept licenses, create credentials, or create a runtime sandbox. The doctor reports host, Docker, GitHub authentication, contributor identity, and commit-signing problems without changing them. Follow its remediation and rerun the doctor until it passes.
Setup installs the required OpenShell SDK from the archive shipped with this checkout and verifies its lockfile checksum. SDK installation does not require GitHub credentials. The doctor also checks that the installed SDK can load. See the SDK archive guidance for direct dependency installation and SDK updates.
Use ./scripts/dev-setup.sh --with-runtime only when the change needs runtime validation. Use
./scripts/dev-setup.sh --expose-cli only when you need a development nemoclaw command. Run
npm run agent to launch the repository-pinned coding agent.
The setup script is the source of truth for setup modes. Contributors who use a compatible coding agent can use the optional onboarding skill. The agent instructions provide a compact command index.
Translate the accepted issue or proposed change into observable success criteria. Define the change boundary and record assumptions that affect behavior, security, data safety, or a supported contract. Get alignment when reasonable interpretations would produce different outcomes.
Keep every changed line within that boundary. Disclose a necessary scope deviation before making it,
and report unrelated debt separately. Then implement the smallest complete change. Follow the active AGENTS.md files and README files for every path you
change; the nearest file owns component-specific rules.
Use these guides to find the relevant contract:
| Work | Owning guidance |
|---|---|
| Repository architecture, code conventions, and product scope | AGENTS.md |
| Ordinary and package-contract tests | test/README.md |
| Live E2E selection, authoring, and evidence | test/e2e/README.md |
| E2E logs and artifacts | test/e2e/docs/README.md |
| User documentation | docs/CONTRIBUTING.md |
| Messaging architecture | src/lib/messaging/AGENTS.md |
| Explanatory text and test titles | WRITING.md |
| Available npm commands | package.json |
| Git-hook configuration | .pre-commit-config.yaml |
| Blueprint image pins | AGENTS.md |
Do not copy detailed component rules into this guide. Update the owning guide when a change alters a component contract.
Run the narrowest tests and checks that prove the outcome. The owning guides above define test placement and specialized evidence. Common starting points are:
npm run test:changedNormal Git hooks validate committed changes. If hooks were skipped or unavailable, commit the
changes, run git fetch origin main, then run npm run validate:pr. This command compares committed
changes with origin/main and requires a clean worktree. It checks formatting without applying fixes.
Complete formatting and generated-file updates before the final commit.
When adding or renaming a hook, classify its read-only behavior in
scripts/checks/read-only-config.mts; publication validation rejects unclassified hooks.
Repository checks report per-check durations and select checks from the hook file list, including
deletions. npm run checks:repository still runs every repository check. Compiler checks reuse a
successful local result only while the recorded inputs and required generated outputs remain unchanged.
Use the commands defined in package.json for component type-checking, builds,
documentation validation, or focused test projects. Use repository-wide validation only when the
change has repository-wide impact or targeted validation cannot prove the outcome:
npm testruns every non-live test project.npm run checkruns the repository-wide pre-commit and coverage baseline.
Most focused changes do not require both. Record only checks that actually ran and their results.
CI / Main Branch packages the approved OpenShell SDK and any approved replacement without executing PR code.
The package token exists only in that job's download step. PR jobs receive no package credentials.
They select a retained archive by the base policy's package identities and verify its checksum against that policy and their lockfiles.
Archives are retained for 90 days and can serve multiple PR commits.
If the archive is missing, run gh workflow run main.yaml --ref main and wait for package-openshell-sdk to succeed.
Then rerun PR CI. If the base package policy changed, update the PR against main before rerunning.
A new SDK version must be approved in the base policy before a PR can install it.
Every pull request requires maintainer review. The applicable open-PR limit is defined in
.github/pr-limits.json; automation closes a pull request that exceeds it.
Do not add links to unofficial repositories, community collections, wrappers, or templates. The NVIDIA NemoClaw Community repository is the designated destination for independent solutions; it is an NVIDIA repository, not an external project. Link to it directly for examples or contribution instructions. Use Community Solutions when readers need help choosing the appropriate repository.
Before publication:
- Rebase or merge the current target branch as required by the repository workflow.
- Run the applicable validation and keep the branch focused.
- Use a Conventional Commit message and ensure each commit appears as
Verifiedon GitHub. - Complete the pull request template, including the Developer Certificate of Origin declaration and completed validation evidence.
- Confirm the diff contains no secrets, API keys, credentials, or unrelated changes.
Contributors must repair commit-signature failures. If a published unverified commit cannot be replaced, create a compliant branch and pull request. GitHub documents commit verification and commit signing.
The pull request template is the source of truth for description content and conditional evidence. The contributor PR skill owns the automated publication and review-follow-up workflow. The root PR requirements own repository-specific exceptions.
After each revision, follow CI and review to completion. Address valid findings with a change, or explain why they do not apply. Keep the PR description and validation evidence current.