docs: clarify macOS onboarding and troubleshooting#6496
Conversation
There was a problem hiding this comment.
Code Review
This pull request updates the Node.js and PNPM prerequisites and adds macOS-specific troubleshooting documentation in CONTRIBUTING.md and README.md. It recommends Node 24.x and PNPM 10.26.x to avoid engine mismatch errors, and increases the default NODE_OPTIONS heap size limit to 8192 for macOS/Linux. Feedback was provided to update the global PNPM installation command in CONTRIBUTING.md to target version 10 explicitly, preventing contributors from accidentally installing an incompatible version.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
|
@HenryHengZJ can you please have a look and review this PR |
Problem
macOS local setup can fail with unclear or inconsistent errors for new contributors.
24.xand pnpm10.26.x, but this is not clearly surfaced in the onboarding flow.11.xmay result in engine mismatch errors.nvm-managed installations.zshmay continue using a cached binary path unlesshash -ris run.JavaScript heap out of memory.Why This Helps
Changes Made
README.md
Added:
24.x)10.26.x)nvmandcorepackCONTRIBUTING.md
Added:
hash -rshell refresh instructionsnvmpnpm path guidance.nvmrc
Updated:
.nvmrcto use24for a simpler and more consistent local setup experience.Scope
Tested On
24.x10.26.x