Skip to content

docs: add Windows contributor setup guide#3813

Open
yejiming wants to merge 2 commits intoethereum:mainfrom
yejiming:docs/windows-contributor-guide
Open

docs: add Windows contributor setup guide#3813
yejiming wants to merge 2 commits intoethereum:mainfrom
yejiming:docs/windows-contributor-guide

Conversation

@yejiming
Copy link
Copy Markdown

What was wrong?

docs/README-windows.md only contained placeholder TODO items, so Windows contributors did not have a usable setup guide.

How was it fixed?

  • documented a native Windows workflow using conda
  • documented a WSL-based workflow for contributors who want a Linux-like setup
  • added a newsfragment for the documentation update

Todo:

  • Clean up commit history
  • Add or update documentation related to these changes
  • Add entry to the release notes

Cute Animal Picture

https://images.unsplash.com/photo-1516934024742-b461fba47600

@yejiming yejiming marked this pull request as ready for review March 28, 2026 14:28
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 98dde36c26

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/README-windows.md
Comment on lines +38 to +39
python -m pip install -e ".[dev]"
pre-commit install
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Document shell requirement for pre-commit on native Windows

The native Windows workflow asks contributors to run pre-commit install from Anaconda Prompt or PowerShell, but this repository includes a local pre-commit hook that runs sh -c ... (.pre-commit-config.yaml), which fails when sh is not available on PATH (a common default in these shells). In that setup, contributors who follow this guide will hit hook execution failures on commit, so the instructions should call out a Git Bash/WSL requirement or provide a PowerShell-compatible alternative.

Useful? React with 👍 / 👎.

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