Skip to content

Conversation

@WuMingDao
Copy link
Contributor

@WuMingDao WuMingDao commented Nov 6, 2025

🎯 Changes

βœ… 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 contributing guide: clarified wording, expanded one-click online setup instructions, added explicit build/run steps (root build, start, and docs dev commands), and preserved clone/install steps for clearer onboarding.

@changeset-bot
Copy link

changeset-bot bot commented Nov 6, 2025

⚠️ No Changeset found

Latest commit: 4b54fac

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 6, 2025

Walkthrough

Updates CONTRIBUTING.md: minor wording edits and an expanded "Online one-click setup" with explicit build/run steps including npm start at repository root and npm run dev in /docs, plus an added root-level auto-build command step.

Changes

Cohort / File(s) Summary
Documentation Updates
CONTRIBUTING.md
Minor grammatical/style adjustments (e.g., "the instructions", "that is"). Expanded Online one-click setup: clarified description and added explicit commands and steps β€” run a root-level auto-build command, npm start at repository root, and npm run dev in /docs.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Single documentation file changed
  • No code or behavioral changes
  • Review focus: clarity and accuracy of instructions

Poem

🐰 A dash of polish, a hop of glee,
Words tightened up β€” now clearer to see,
Root builds hum, docs start to sing,
npm commands make setup spring,
Tiny changes, big tidy tree.

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
βœ… Passed checks (2 passed)
Check name Status Explanation
Title check βœ… Passed The title accurately describes the main change: grammar and wording improvements in CONTRIBUTING.md, which aligns with the documented modifications to sentence phrasing and clarity.
Description check βœ… Passed The description follows the required template structure with all sections present, but the 'Changes' section lacks specific detail about what modifications were made and their motivation.
✨ Finishing touches
πŸ§ͺ Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

πŸ“œ Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between 41f990b and 4b54fac.

πŸ“’ Files selected for processing (1)
  • CONTRIBUTING.md (1 hunks)
🧰 Additional context used
πŸͺ› LanguageTool
CONTRIBUTING.md

[style] ~136-~136: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...## Note on standalone execution If you want to run an example without installing depen...

(REP_WANT_TO_VB)

πŸ”‡ Additional comments (3)
CONTRIBUTING.md (3)

136-136: Grammatical improvement approved.

Adding the definite article "the" and proper punctuation enhances clarity. The sentence now reads more naturally.


140-140: Hyphenation fix resolves previous feedback.

The compound adjectives are now properly hyphenated ("open-source" and "VS Code-like"), and "which" has been changed to "that" for the restrictive clause. This addresses the earlier review comment on grammar.


144-154: Clear expansion of Gitpod setup instructions.

The explicit build and run commands make the setup process more transparent and easier to follow. Developers will benefit from the step-by-step guidance for running npm start at the root and npm run dev in /docs.


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 and usage tips.

Copy link
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

🧹 Nitpick comments (1)
CONTRIBUTING.md (1)

136-136: Consider rewording to reduce phrase repetition.

The phrase "If you want to" appears in nearby sentences (line 128 and here). While grammatically correct, rewording for variety would improve readability.

Consider: "To run an example without installing dependencies for the whole repo, just follow the instructions from the example's README.md file."

πŸ“œ Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between ea0ab4d and 41f990b.

πŸ“’ Files selected for processing (1)
  • CONTRIBUTING.md (1 hunks)
🧰 Additional context used
πŸͺ› LanguageTool
CONTRIBUTING.md

[style] ~136-~136: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...## Note on standalone execution If you want to run an example without installing depen...

(REP_WANT_TO_VB)


[uncategorized] ~140-~140: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ck setup You can use Gitpod (An Online Open Source VS Code like IDE that is free for Open ...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


[grammar] ~140-~140: Use a hyphen to join words.
Context: ...se Gitpod (An Online Open Source VS Code like IDE that is free for Open Source) f...

(QB_NEW_EN_HYPHEN)

πŸ”‡ Additional comments (1)
CONTRIBUTING.md (1)

142-154: Excellent expansion of Gitpod setup instructions.

The addition of explicit npm start and npm run dev commands with clear annotations ("Auto-build files", "/docs") significantly improves clarity for contributors using the one-click setup. This makes the automated build process transparent and easier to follow.

@TkDodo TkDodo merged commit ddac129 into TanStack:main Nov 6, 2025
2 checks passed
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.

2 participants