docs: update stale version requirements and replace Yarn with npm#5600
Open
ms2073 wants to merge 1 commit intoup-for-grabs:gh-pagesfrom
Open
docs: update stale version requirements and replace Yarn with npm#5600ms2073 wants to merge 1 commit intoup-for-grabs:gh-pagesfrom
ms2073 wants to merge 1 commit intoup-for-grabs:gh-pagesfrom
Conversation
CONTRIBUTING.md: - Update Ruby requirement from 3 to 4 (repo uses ruby '~> 4.0') - Update Node requirement from 16+ to 24+ (package.json engines: node >=24) - Update example output to reflect current Ruby 4.0 and Node 24.x - Fix outdated Docker install links for Windows, macOS, and Linux docs/setup.md: - Replace Yarn with npm throughout (no yarn.lock exists, package.json specifies npm >=11 engine) - Fix 'yarn prettify' (script does not exist) → 'npm run prettier' - Fix 'yarn lint' → 'npm run lint' - Fix eslintrc.json reference → eslint.config.mjs (flat config) docs/client-side-scripting.md: - Fix 'yarn test' → 'npm test'
✅ Deploy Preview for up-for-grabs-test-bench ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
👋 I'm a robot checking the state of this pull request to save the human reviewers time. I don't see any changes under As you make changes to this pull request, I'll re-run these checks. |
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
2 participants
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.
Problem
The contributor documentation had significantly outdated information that would cause setup failures for new contributors:
CONTRIBUTING.mdstates Ruby 3 / Node 16+, but the repo'sGemfilerequiresruby '~> 4.0',.ruby-versionis4.0.0, andpackage.jsonengines specifynode >=24, npm >=11docs/setup.mduses Yarn throughout, but the project has noyarn.lock,package.jsonspecifiesnpm >=11, and all CI scripts use npmyarn prettifydoes not exist; the correct command isnpm run prettiereslintrc.jsonbut the project migrated to ESLint flat config (eslint.config.mjs)Changes
.github/CONTRIBUTING.mddocs/setup.mdyarn→npm installyarn prettify→npm run prettieryarn lint→npm run linteslintrc.json→eslint.config.mjsdocs/client-side-scripting.mdyarn test→npm testVerification
Gemfile,.ruby-version,package.jsonnpm run prettier,npm run lint,npm testexist inpackage.jsoneslint.config.mjsexists in repo root