Skip to content

docs(CONTRIBUTING): replace 'npm run test' and 'npx nx' command with 'pnpm' equivalents#11095

Open
Antoliny0919 wants to merge 1 commit into
TanStack:mainfrom
Antoliny0919:refactor-npm-to-pnpm
Open

docs(CONTRIBUTING): replace 'npm run test' and 'npx nx' command with 'pnpm' equivalents#11095
Antoliny0919 wants to merge 1 commit into
TanStack:mainfrom
Antoliny0919:refactor-npm-to-pnpm

Conversation

@Antoliny0919

@Antoliny0919 Antoliny0919 commented Jul 21, 2026

Copy link
Copy Markdown

🎯 Changes

The project currently uses pnpm as its package manager. While using npm isn't an issue, I think it would be more consistent to update the contribution guide to use pnpm throughout as well.

✅ 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 testing instructions to use pnpm commands.
    • Revised guidance for running all tests and tests for individual packages.

@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: 30e65708-8d2d-4a8b-b91c-9578b8dd47cf

📥 Commits

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

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

📝 Walkthrough

Walkthrough

Updated CONTRIBUTING.md to use pnpm for running all tests and package-specific library tests.

Changes

Test command documentation

Layer / File(s) Summary
Update test command instructions
CONTRIBUTING.md
The contributor guide now uses pnpm run test and pnpm nx run ...:test:lib commands.

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

Possibly related PRs

  • TanStack/query#11066: Updates overlapping CONTRIBUTING.md guidance for running commands with pnpm.

Suggested reviewers: kobihikri

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly matches the PR’s main change: switching CONTRIBUTING.md commands to pnpm equivalents.
Description check ✅ Passed The description follows the template and includes the changes, checklist, and release impact sections.
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