Skip to content

docs: add Windows contributor setup guide - #54

Merged
SaharPak merged 3 commits into
TechImmigrants:mainfrom
ded-furby:docs/windows-setup-guide
Jun 18, 2026
Merged

docs: add Windows contributor setup guide#54
SaharPak merged 3 commits into
TechImmigrants:mainfrom
ded-furby:docs/windows-setup-guide

Conversation

@ded-furby

@ded-furby ded-furby commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

What does this PR do?

Adds a dedicated Windows contributor setup guide and links to it from CONTRIBUTING.md.

The new guide covers:

  • installing Node.js 20 with nvm-windows or direct download
  • installing pnpm with corepack enable or a global npm fallback
  • Git line ending configuration
  • PowerShell vs Git Bash usage
  • common Windows gotchas such as long paths and PowerShell execution policy

Related issue

Closes #49

Type of change

  • Bug fix
  • New feature
  • New archetype / rule
  • Documentation
  • Refactoring (no behavior change)
  • CI / tooling

Checklist

  • I've read CONTRIBUTING.md
  • My code follows the project's style
  • I've added/updated tests (if applicable)
  • I've tested locally and it works
  • New archetypes include 15+ keywords and source references

Validation

  • pnpm test
  • pnpm build
  • pnpm exec prettier --write CONTRIBUTING.md docs/WINDOWS_SETUP.md
  • pnpm format:check ⚠️ fails on multiple pre-existing files unrelated to this PR, including .github templates, README.md, and several existing docs/source files

Screenshots (if UI change)

Not applicable.

Summary by CodeRabbit

  • Documentation
    • Added a Windows-specific setup guide covering Node.js installation, pnpm setup via corepack (with npm fallback), Git line-ending configuration, shell selection (PowerShell vs Git Bash), and common troubleshooting steps.
    • Updated the contribution guidelines to direct Windows developers to the new setup guide before running repo setup commands.

@coderabbitai

coderabbitai Bot commented Jun 11, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: fddecc6f-ce79-437d-a449-c4e0746d4e3f

📥 Commits

Reviewing files that changed from the base of the PR and between 7bd2cb5 and c364a6a.

📒 Files selected for processing (1)
  • docs/WINDOWS_SETUP.md
✅ Files skipped from review due to trivial changes (1)
  • docs/WINDOWS_SETUP.md

📝 Walkthrough

Walkthrough

Adds docs/WINDOWS_SETUP.md, a new Windows-specific contributor setup guide covering Node.js 20, pnpm via corepack, Git line endings, shell selection, and common gotchas. Updates CONTRIBUTING.md to reference this guide before the standard setup commands, plus inserts minor blank lines for spacing.

Changes

Windows Setup Documentation

Layer / File(s) Summary
Windows setup guide
docs/WINDOWS_SETUP.md
New 114-line guide covering Node.js 20 installation, pnpm setup via corepack (with npm fallback), core.autocrlf Git config, PowerShell vs Git Bash command examples, troubleshooting for long paths and execution policy, and the standard contributor workflow commands.
CONTRIBUTING.md reference and spacing
CONTRIBUTING.md
Adds a Windows prerequisite note before the setup commands directing contributors to docs/WINDOWS_SETUP.md; inserts blank lines in the Branch naming, Submit a pull request, and First Time Contributing sections.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Poem

🐇 Hippity-hop, a new doc appears,
For Windows folks who've struggled with fears!
Long paths and shells, now explained with care,
corepack enable floats right through the air.
No more lost bunnies — just follow the guide,
And build your CV with bunny-hop pride! 🥕

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately and concisely summarizes the main change: adding a Windows contributor setup guide to the documentation.
Linked Issues check ✅ Passed The pull request fully addresses all coding requirements from issue #49: Node.js installation guidance, pnpm setup, Git line endings, PowerShell vs Git Bash guidance, and common Windows gotchas are all documented.
Out of Scope Changes check ✅ Passed All changes are directly scoped to issue #49 requirements: a new Windows setup guide and CONTRIBUTING.md update to reference it, with no unrelated modifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between a920f4d and 7bd2cb5.

📒 Files selected for processing (2)
  • CONTRIBUTING.md
  • docs/WINDOWS_SETUP.md

Comment thread docs/WINDOWS_SETUP.md Outdated
@SaharPak
SaharPak merged commit 7c0fba6 into TechImmigrants:main Jun 18, 2026
3 checks passed
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.

[Docs] Add Windows setup guide

2 participants