Skip to content

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

Merged
cv merged 7 commits intoNVIDIA:mainfrom
dknos:fix/contributing-npm-link-1429
Apr 8, 2026
Merged

docs(contributing): add npm link step to developer setup#1483
cv merged 7 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
Fixes #989

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added a "Local Development Testing" section to the contribution guidelines with step-by-step instructions to build the project, locally link the CLI for testing, verify the linked CLI version, and unlink the local CLI after testing. Documentation-only change to help contributors test CLI changes without modifying code.

Signed-off-by: dknos rneebo@gmail.com

Signed-off-by: dknos rneebo@gmail.com

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 5, 2026

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

Added a "Local Development Testing" subsection to CONTRIBUTING.md instructing developers to run npm link from the repo root (including an explicit cd .. if inside nemoclaw/), verify with nemoclaw --version, and use npm unlink -g nemoclaw to undo. Documentation-only change.

Changes

Cohort / File(s) Summary
Documentation
CONTRIBUTING.md
Added "Local Development Testing" section with post-build CLI workflow: cd .. if inside nemoclaw/, run npm link, verify via nemoclaw --version, and teardown using npm unlink -g nemoclaw.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 I hopped into docs with a wink and a blink,
Linked the CLI so local tests won't sink,
npm link — a hop to make commands come true,
nemoclaw --version — a quick peep through,
npm unlink — tidy trail, carrot-cheery adieu 🥕

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The PR title accurately reflects the main change: adding npm link documentation to the developer setup in CONTRIBUTING.md.
Linked Issues check ✅ Passed The PR fulfills all coding requirements from issues #1429 and #989: adds the missing npm link step, includes verification command, provides unlink instructions, and clarifies working directory context.
Out of Scope Changes check ✅ Passed All changes are directly related to the linked issues. Only CONTRIBUTING.md was modified with a new Local Development Testing section, which is exactly what the issues required.
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.

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

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

@prekshivyas prekshivyas self-assigned this Apr 7, 2026
@prekshivyas
Copy link
Copy Markdown
Contributor

Thanks for this contribution @dknos — clean, well-scoped fix that addresses #1429 exactly. Appreciate you following up on the CodeRabbit working-directory feedback too.

One blocker before we can merge:

DCO sign-off missing. The dco-check CI is failing because the PR description needs a Signed-off-by: line. Please add the following to the bottom of your PR description:

Signed-off-by: Your Name <your-email@example.com>

Once that's in place, this is good to go.

@dknos dknos force-pushed the fix/contributing-npm-link-1429 branch from 5bfe5e4 to 0a628f7 Compare April 8, 2026 05:59
dknos added 3 commits April 8, 2026 01:32
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>

Signed-off-by: dknos <rneebo@gmail.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Signed-off-by: dknos <rneebo@gmail.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>

Signed-off-by: dknos <rneebo@gmail.com>
@dknos dknos force-pushed the fix/contributing-npm-link-1429 branch from 0a628f7 to afc522e Compare April 8, 2026 06:32
@prekshivyas prekshivyas requested review from cv and miyoungc April 8, 2026 18:28
@cv cv merged commit ee73f53 into NVIDIA:main Apr 8, 2026
9 checks passed
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

5 participants