docs: add Windows contributor setup guide#3813
docs: add Windows contributor setup guide#3813yejiming wants to merge 2 commits intoethereum:mainfrom
Conversation
There was a problem hiding this comment.
💡 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".
| python -m pip install -e ".[dev]" | ||
| pre-commit install |
There was a problem hiding this comment.
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 👍 / 👎.
What was wrong?
docs/README-windows.mdonly contained placeholder TODO items, so Windows contributors did not have a usable setup guide.How was it fixed?
condaTodo:
Cute Animal Picture
https://images.unsplash.com/photo-1516934024742-b461fba47600