Skip to content

Added WSL setup text to CONTRIBUTING.md #144

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
merged 2 commits into from
Apr 28, 2022
Merged

Added WSL setup text to CONTRIBUTING.md #144

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dc5aa02
Added WSL setup text to CONTRIBUTING.md
adhadse Apr 28, 2022
7f2c2a4
Update language
mattdangerw Apr 28, 2022
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
21 changes: 15 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,21 @@ request gets approved by the reviewer.

Once the pull request is approved, a team member will take care of merging.

## Developing on Windows

For Windows development, we recommend using WSL (Windows Subsystem for Linux),
so you can run the shell scripts in this repository. We will not support
Windows Shell/PowerShell. You can refer
[to these instructions](https://docs.microsoft.com/en-us/windows/wsl/install)
for WSL installation.

Note that if you are using Windows Subsystem for Linux (WSL), make sure you
clone the repo with Linux style LF line endings and change the default setting
for line separator in your Text Editor before running the format
or lint scripts. This is automatically done if you clone using git inside WSL.
If there is conflict due to the line endings you might see an error
like - `: invalid option`.

## Setup environment

Python 3.7 or later is required.
Expand Down Expand Up @@ -112,12 +127,6 @@ If after running these the CI flow is still failing, try updating `flake8`,
`isort` and `black`. This can be done by running `pip install --upgrade black`,
`pip install --upgrade flake8`, and `pip install --upgrade isort`.

Note that if you are using Windows Subsystem for Linux (WSL), make sure you
clone the repo with Linux style LF line endings before running the format
or lint scripts. This is automatically done if you clone using git inside WSL.
If there is conflict due to the line endings you might see an error
like - `: invalid option`

## Community Guidelines

This project follows
Expand Down