Skip to content

docs: update CONTRIBUTING.md and README contribute section - #902

Merged
jordan-a-young merged 1 commit into
masterfrom
docs/update-contributing-guide
Sep 17, 2026
Merged

jordan-a-young merged 1 commit into
masterfrom
docs/update-contributing-guide

Conversation

@jordan-a-young

Copy link
Copy Markdown
Member

Summary

Updates the contributing documentation to reflect the current state of the repo.

Changes

CONTRIBUTING.md:

  • Replace outdated npm install -g yarn with Corepack-based setup for Yarn 4.x
  • Remove reference to non-existent yarn run new script
  • Remove stale "not yet using Plug'n'Play" comment
  • Add Node ≥ 22.12.0 prerequisite (matches engines field and CI matrix)
  • Add a packages table listing all monorepo packages (including workflow-vite)
  • Expand testing section with Vite example app scripts, yarn test:affected, and linting commands
  • Replace outdated yarn version check --interactive (yarn berry release workflow) with the actual @jscutlery/semver + yarn version:dry-run setup
  • Fix commit scope guidance to reference NX project names (per @commitlint/config-nx-scopes)

README:

  • Expand the Contribute section from a 2-line placeholder to a proper quick-start block with all relevant commands

Testing

Documentation-only change — no code modified.

- Replace outdated yarn install instructions (npm install -g yarn)
  with Corepack-based approach for Yarn 4.x
- Remove non-existent 'yarn run new' script reference
- Remove stale 'not yet using PnP' comment
- Add Node >=22.12.0 prerequisite
- Add packages table listing all monorepo packages
- Expand testing section with Vite example app scripts,
  yarn test:affected, and linting commands
- Replace outdated yarn version check --interactive with
  @jscutlery/semver + yarn version:dry-run workflow
- Fix commit scope guidance to reference NX project names
- Update README Contribute section from a 2-line placeholder
  to a full quick-start with all relevant commands
@jordan-a-young
jordan-a-young merged commit cd71c24 into master Sep 17, 2026
5 checks passed
@jordan-a-young
jordan-a-young deleted the docs/update-contributing-guide branch September 17, 2026 16:25
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