Skip to content

docs(contributing): add npm link step to developer setup#1483

Open
dknos wants to merge 3 commits intoNVIDIA:mainfrom
dknos:fix/contributing-npm-link-1429
Open

docs(contributing): add npm link step to developer setup#1483
dknos wants to merge 3 commits intoNVIDIA:mainfrom
dknos:fix/contributing-npm-link-1429

Conversation

@dknos
Copy link
Copy Markdown
Contributor

@dknos dknos commented Apr 5, 2026

Summary

  • Adds missing npm link step to the developer setup section in CONTRIBUTING.md
  • Required for the nemoclaw CLI to work locally during development

Test plan

  • Follow the updated setup instructions from scratch
  • Verify nemoclaw command is available after setup

Fixes #1429

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added a Local Development Testing section to contribution guidelines with step-by-step instructions to build, locally link and verify the CLI, plus how to unlink the local CLI after testing.

The nemoclaw CLI requires npm link to be available as a local
command during development. This step was missing from the setup
instructions.

Fixes NVIDIA#1429

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 5, 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: dabe6ccc-d136-45c9-810c-13d4d4f1eb72

📥 Commits

Reviewing files that changed from the base of the PR and between f38642e and 95d00e2.

📒 Files selected for processing (1)
  • CONTRIBUTING.md
✅ Files skipped from review due to trivial changes (1)
  • CONTRIBUTING.md

📝 Walkthrough

Walkthrough

A "Local Development Testing" section was added to CONTRIBUTING.md with instructions to run npm link from the repository root (noting cd .. when starting inside nemoclaw/), verify with nemoclaw --version, and unlink with npm unlink -g nemoclaw. Documentation-only change.

Changes

Cohort / File(s) Summary
Documentation
CONTRIBUTING.md
Added a "Local Development Testing" section instructing developers to run npm link after building, verify the linked CLI with nemoclaw --version, include the cd .. note when appropriate, and provide the npm unlink -g nemoclaw cleanup command.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 I hopped through docs with nimble feet,

Added a link to make testing neat.
npm link whispers, "Try me, friend!"
Verify the version, then unlink in the end.
A tiny bounce for developer cheer 🥕

🚥 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 directly and clearly describes the main change: adding the npm link step to the developer setup documentation.
Linked Issues check ✅ Passed The PR successfully implements all coding requirements from issue #1429: adds the Local Development Testing section with npm link, verification command, and unlink instructions.
Out of Scope Changes check ✅ Passed All changes are directly related to resolving issue #1429; only CONTRIBUTING.md was modified with the requested npm link documentation addition.
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.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@CONTRIBUTING.md`:
- Around line 56-61: The docs risk instructing users to run npm link from the
wrong directory (e.g., still in ./nemoclaw) which can link the plugin instead of
the root CLI; update the CONTRIBUTING.md step before the npm link command to
make the working directory explicit by telling users to return to the repo root
(or run the appropriate cd) so npm link targets the CLI package, then run npm
link and verify with the nemoclaw --version check.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 3b8f0111-0648-4d9b-a5b7-76d01e93c77c

📥 Commits

Reviewing files that changed from the base of the PR and between c99e3e8 and f38642e.

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

miyoungc and others added 2 commits April 4, 2026 20:21
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add explicit cd .. instruction since the previous build step leaves the
user inside the nemoclaw/ subdirectory.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@dknos
Copy link
Copy Markdown
Contributor Author

dknos commented Apr 6, 2026

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 6, 2026

✅ 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.

Copy link
Copy Markdown
Contributor Author

@dknos dknos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed: the working directory before npm link is now explicit. After the plugin build step leaves the user in nemoclaw/, a cd .. returns them to the repo root before running npm link, ensuring the CLI package (not the plugin) is linked. See commits 785f2b4 and 95d00e2.

@wscurran wscurran added documentation Improvements or additions to documentation NemoClaw CLI Use this label to identify issues with the NemoClaw command-line interface (CLI). labels Apr 6, 2026
@dknos
Copy link
Copy Markdown
Contributor Author

dknos commented Apr 6, 2026

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 6, 2026

✅ 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

documentation Improvements or additions to documentation NemoClaw CLI Use this label to identify issues with the NemoClaw command-line interface (CLI).

Projects

None yet

Development

Successfully merging this pull request may close these issues.

CONTRIBUTING.md Missing npm link Step — Developer Setup Path Broken - IssueFinder - SN 07

3 participants