docs: refresh contributing guide commands#2545
Open
pengqima wants to merge 1 commit into
Open
Conversation
Signed-off-by: pengqima <pengqima@outlook.com>
pengqima
requested review from
Richard-Dang,
SahilAujla,
avarobinson,
blakecduncan,
clinder777,
dancoombs,
florrdv,
jakehobbs,
niveda-krish,
pavelm and
thebrianchen
as code owners
June 25, 2026 17:15
Author
|
@pavelm @Richard-Dang @jakehobbs Hi, Could you please review this PR at your convenience? Thank you very much. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request Checklist
pnpm test)docsfolder, and guidelines for updating/adding docs can be found in the contribution guide)feat!: breaking change)pnpm run lint:check) and fix any issues? (pnpm run lint:write)Updates the contributing guide so the setup and validation steps match the current v5 workspace.
This refreshes the documented Node requirement, pnpm usage, build/test commands, and docs validation commands. It also removes references to stale paths and scripts that are no longer tracked in the repository.
Summary
Updates the contributing guide so the setup and validation steps match the current v5 workspace.
This refreshes the documented Node requirement, pnpm usage, build/test commands, and docs validation commands. It also removes references to stale paths and scripts that are no longer tracked in the repository.
Why
The existing guide still referenced older contributor workflow details, including Node 18.16.0,
pnpm test,pnpm run docs:dev,site/packages/*, anddocs/CONTRIBUTING.md. These no longer match the currentmainbranch configuration and can send new contributors down a dead path.Testing
pnpm run lint:check