Skip to content

docs: prefer pnpm script shorthand in contributing guide#19747

Closed
pavan-sh wants to merge 1 commit intotailwindlabs:mainfrom
pavan-sh:docs/link-hygiene-and-commands
Closed

docs: prefer pnpm script shorthand in contributing guide#19747
pavan-sh wants to merge 1 commit intotailwindlabs:mainfrom
pavan-sh:docs/link-hygiene-and-commands

Conversation

@pavan-sh
Copy link
Contributor

@pavan-sh pavan-sh commented Mar 2, 2026

Summary

This PR updates the contributing guide to use pnpm’s script shorthand for consistency and copy/paste friendliness:

  • pnpm run lintpnpm lint
  • pnpm run formatpnpm format

These commands are equivalent, but the shorthand matches the rest of the repo’s script usage and reduces noise in documentation.

Test plan

  • Verified the lint and format scripts exist in the root package.json.
  • Ran Prettier formatting check on the edited file:
pnpm prettier --check .github/CONTRIBUTING.md

@pavan-sh pavan-sh requested a review from a team as a code owner March 2, 2026 17:36
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 2, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bf2e2fe and 204eedd.

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

Walkthrough

The PR updates the CONTRIBUTING.md documentation file to standardize command invocations for npm scripts. Specifically, it replaces "pnpm run lint" with "pnpm lint" and "pnpm run format" with "pnpm format" in the documentation. These are documentation-only changes with no functional or behavioral modifications. No public APIs or exported declarations are altered. The change involves 2 lines added and 2 lines removed.

🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically summarizes the main change: updating documentation to use pnpm script shorthand in the contributing guide.
Description check ✅ Passed The description is directly related to the changeset, providing clear context about why the changes were made, what was changed, and how it was tested.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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.

@RobinMalfait
Copy link
Member

Let's keep it as is. No need to change this 👍

@pavan-sh
Copy link
Contributor Author

pavan-sh commented Mar 3, 2026

Let's keep it as is. No need to change this 👍

No problem. Thanks for review and valuable time.

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