Skip to content

Update CONTRIBUTING.md to include commands for Windows #17142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hauntsaninja merged 2 commits into from
Apr 22, 2024
Merged

Update CONTRIBUTING.md to include commands for Windows #17142

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
da458cc
Update CONTRIBUTING.md to include commands for Windows
GiorgosPapoutsakis Apr 18, 2024
5a92e3a
Update CONTRIBUTING.md
hauntsaninja Apr 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,17 +30,23 @@ cd mypy
#### (3) Create then activate a virtual environment

```bash
# On Windows, the commands may be slightly different. For more details, see
# https://docs.python.org/3/library/venv.html#creating-virtual-environments
python3 -m venv venv
source venv/bin/activate
```

```bash
# For Windows use
python -m venv venv
. venv/Scripts/activate

# For more details, see https://docs.python.org/3/library/venv.html#creating-virtual-environments
```

#### (4) Install the test requirements and the project

```bash
python3 -m pip install -r test-requirements.txt
python3 -m pip install -e .
python -m pip install -r test-requirements.txt
python -m pip install -e .
hash -r # This resets shell PATH cache, not necessary on Windows
```

Expand Down