Skip to content

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

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

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

Conversation

@dknos
Copy link
Copy Markdown

@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 local development testing section to contribution guidelines with instructions for building and verifying the CLI locally using package linking.

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

Warning

Rate limit exceeded

@dknos has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 1 minutes and 13 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 1 minutes and 13 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 4719dc6f-bafd-4398-9900-63e4e1364ce0

📥 Commits

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

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

Walkthrough

A "Local Development Testing" section was added to CONTRIBUTING.md with instructions for using npm link to test the locally built nemoclaw CLI tool, including verification steps and the corresponding unlink command. This is a documentation-only change with no code modifications.

Changes

Cohort / File(s) Summary
Documentation
CONTRIBUTING.md
Added "Local Development Testing" section with npm link setup instructions for local CLI verification and cleanup steps.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A whisker-twitch of joy, I say,
For docs that guide the testing way!
npm link now lights the dev's bright path,
No more confusion's aftermath!

🚥 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 clearly describes the main change: adding npm link documentation to the developer setup section of CONTRIBUTING.md.
Linked Issues check ✅ Passed The PR fully implements the requirements from issue #1429 by adding the missing npm link step with local development testing instructions as suggested.
Out of Scope Changes check ✅ Passed All changes are directly scoped to addressing issue #1429; only documentation additions to CONTRIBUTING.md with no unrelated modifications.
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

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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.

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

2 participants