Skip to content

docs: add npm link to contributor setup#1003

Open
WuKongAI-CMU wants to merge 1 commit intoNVIDIA:mainfrom
WuKongAI-CMU:docs/989-contributing-npm-link
Open

docs: add npm link to contributor setup#1003
WuKongAI-CMU wants to merge 1 commit intoNVIDIA:mainfrom
WuKongAI-CMU:docs/989-contributing-npm-link

Conversation

@WuKongAI-CMU
Copy link
Copy Markdown
Contributor

@WuKongAI-CMU WuKongAI-CMU commented Mar 26, 2026

Summary

  • add the missing npm link step to the contributor setup flow
  • explain that it puts the local nemoclaw CLI on the developer PATH

Testing

  • not run (docs-only change)

Closes #989

Summary by CodeRabbit

  • Documentation
    • Updated "Getting Started" instructions to include an npm link step for local CLI development setup.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 26, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: ac1f37ce-7f5d-4930-92be-72b40da10e33

📥 Commits

Reviewing files that changed from the base of the PR and between 5c269c1 and 9f8251b.

📒 Files selected for processing (1)
  • CONTRIBUTING.md

📝 Walkthrough

Walkthrough

Updated CONTRIBUTING.md to include the npm link step after installing root dependencies, ensuring developers can access the local nemoclaw CLI binary on their PATH during development. This resolves the missing setup instruction that previously caused "command not found" errors when attempting to run the CLI.

Changes

Cohort / File(s) Summary
Documentation
CONTRIBUTING.md
Added npm link step to developer setup instructions after npm install at repo root to register the nemoclaw CLI binary globally, resolving the broken developer setup path.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A link was missing, oh what a shame!
The CLI could not find its name.
But now with npm link in place,
Developers run with joy and grace! 🚀

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: add npm link to contributor setup' clearly and concisely summarizes the main change—adding npm link to documentation.
Linked Issues check ✅ Passed The PR directly addresses issue #989 by adding the npm link step to CONTRIBUTING.md, resolving the missing setup documentation that caused nemoclaw CLI to be unavailable.
Out of Scope Changes check ✅ Passed The changes are limited to updating CONTRIBUTING.md with the npm link step, which is entirely in scope and aligned with the linked issue requirements.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

@WuKongAI-CMU
Copy link
Copy Markdown
Contributor Author

Addresses #989 by adding the missing npm link step to the contributor setup flow so the local nemoclaw CLI is available on PATH during development.

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 27, 2026

@WuKongAI-CMU Sure! I'll review the changes in this PR now.

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[NeMoClaw][Doc] CONTRIBUTING.md missing npm link step — developer setup path broken

1 participant