Skip to content

docs(CONTRIBUTING): link '.nvmrc' reference to the actual file#11097

Open
Antoliny0919 wants to merge 1 commit into
TanStack:mainfrom
Antoliny0919:link-to-version-nvm
Open

docs(CONTRIBUTING): link '.nvmrc' reference to the actual file#11097
Antoliny0919 wants to merge 1 commit into
TanStack:mainfrom
Antoliny0919:link-to-version-nvm

Conversation

@Antoliny0919

@Antoliny0919 Antoliny0919 commented Jul 21, 2026

Copy link
Copy Markdown

🎯 Changes

CONTRIBUTING.md referenced .nvmrc as plain inline code, so contributors couldn't click through to the file to check the actual node version. Turn the reference into a link pointing to ./.nvmrc 👍

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested this code locally with pnpm run test:pr.

🚀 Release Impact

  • This change affects published code, and I have generated a changeset.
  • This change is docs/CI/dev-only (no release).

Summary by CodeRabbit

  • Documentation
    • Updated the development instructions with a clickable link to the project’s .nvmrc file for easier access.

@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: fa22d88b-c446-423e-aa51-097c66856bac

📥 Commits

Reviewing files that changed from the base of the PR and between 86bb8a6 and f2a89c3.

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

📝 Walkthrough

Walkthrough

The development instructions in CONTRIBUTING.md change the plain-text .nvmrc reference to a clickable relative Markdown link.

Changes

Development Documentation

Layer / File(s) Summary
Link the Node version reference
CONTRIBUTING.md
The required Node version instruction now links .nvmrc to ./.nvmrc.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

  • TanStack/query#11066: Updates a different pnpm version instruction in the same CONTRIBUTING.md development section.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the docs-only change to link the .nvmrc reference.
Description check ✅ Passed The description follows the required template and includes changes, checklist, and release impact details.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

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.

1 participant