Skip to content

docs: add npm link to contributor setup#1003

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

docs: add npm link to contributor setup#1003
WuKongAI-CMU wants to merge 3 commits 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

Signed-off-by: Intern Dev dev@wukongai.io

Summary by CodeRabbit

  • Documentation
    • Updated the Getting Started instructions to add an npm link step and revised wording around linking the local CLI. Existing install and build steps remain unchanged. This clarifies the setup process for contributors and reduces friction when testing locally.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 26, 2026

📝 Walkthrough

Walkthrough

Added an npm link step to CONTRIBUTING.md after the repository root npm install to register the nemoclaw CLI on the developer PATH; remaining setup steps (TypeScript plugin install/build and subsequent commands) are unchanged.

Changes

Cohort / File(s) Summary
Documentation
CONTRIBUTING.md
Inserted npm link after root npm install and updated wording to explain that this links the local nemoclaw CLI into the developer PATH. No other changes to setup commands.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A tiny link, a nimble trick,
The CLI now finds its path so quick.
From root install a gentle wink,
Developers hop — the command will stick. 🥕

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The PR title 'docs: add npm link to contributor setup' accurately reflects the main change: adding npm link documentation to CONTRIBUTING.md.
Linked Issues check ✅ Passed The PR addresses the primary objective from issue #989 by adding the missing npm link step to CONTRIBUTING.md, enabling developers to use the nemoclaw CLI after setup.
Out of Scope Changes check ✅ Passed All changes are directly scoped to addressing issue #989: updating CONTRIBUTING.md with npm link documentation for developer setup.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ 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.

@wscurran wscurran added documentation Improvements or additions to documentation fix labels Mar 30, 2026
@wscurran
Copy link
Copy Markdown
Contributor

✨ Thanks for submitting this fix, it identifies a documentation issue and proposes a solution to add a missing step to the contributor setup flow, which could improve the helpfulness and accuracy of the documentation.

@WuKongAI-CMU WuKongAI-CMU force-pushed the docs/989-contributing-npm-link branch from 9f8251b to c8171ee Compare April 2, 2026 04:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation fix

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

3 participants