docs: update CONTRIBUTING.md and README contribute section - #937
Merged
Merged
Conversation
jordan-a-young
requested review from
LauRoxx and
gregmartDOTin
as code owners
September 17, 2026 16:53
Contributor
|
🚀 Preview deployed! |
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.
What was stale
README.md
v24only —enginesand CI matrix both support v22 and v24npm i -g yarn(missingnpm installform) and no mention of Corepack as the recommended activation path for yarn v4Contributingsection pointing contributors to the guideCONTRIBUTING.md
npm -i -g yarn— wrong flag (-iis not valid here)v24only — CI runs on both 22 and 24yarn vitest packages/alertshown as watch mode — wrong; corrected toyarn vitest --watch packages/alertyarn lintnot documented — onlylint:affectedwas showndocscommits do not trigger a version bumptest:affectedscript not documentedWhat was checked / not changed
@jscutlery/semverconfig: all 54project.jsonfiles already have"skipCommitTypes": ["docs"]— no change neededpackage.jsonpackage.jsonentries or CI configFiles changed
README.md— node version, Corepack instructions, Contributing section.github/CONTRIBUTING.md— prerequisites, contributor workflow, corrected commands, versioning section, docs commit note