docs: add Windows contributor setup guide - #54
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughAdds ChangesWindows Setup Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~4 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/WINDOWS_SETUP.md`:
- Around line 10-11: Update the Node.js version references in the nvm-windows
and direct download installation sections to reflect current supported LTS
versions. Replace the Node.js 20 references (both in the nvm commands and the
nodejs.org download link) with either the current LTS versions (v24 or v26), or
if you must retain Node.js 20 for compatibility reasons, explicitly document
that this setup targets that specific version and update the nodejs.org link in
the direct download section to point to the archive at
https://nodejs.org/dist/latest-v20.x/ instead of the generic download page.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 6701e49a-6a63-4cbe-abc2-9c16af3b9478
📒 Files selected for processing (2)
CONTRIBUTING.mddocs/WINDOWS_SETUP.md
What does this PR do?
Adds a dedicated Windows contributor setup guide and links to it from
CONTRIBUTING.md.The new guide covers:
nvm-windowsor direct downloadcorepack enableor a global npm fallbackRelated issue
Closes #49
Type of change
Checklist
Validation
pnpm test✅pnpm build✅pnpm exec prettier --write CONTRIBUTING.md docs/WINDOWS_SETUP.md✅pnpm format:check.githubtemplates,README.md, and several existing docs/source filesScreenshots (if UI change)
Not applicable.
Summary by CodeRabbit