Skip to content

Commit 44933f7

Browse files
aflah02mattdangerw
andauthored
Added Debug Info for Line Ending Issues (#64)
* Added Debug Info for Line Ending Issues * Updated Debug Message * Define term WSL Co-authored-by: Matt Watson <1389937+mattdangerw@users.noreply.github.com>
1 parent 454b23a commit 44933f7

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,12 @@ If after running these the CI flow is still failing, try updating `flake8`,
106106
`isort` and `black`. This can be done by running `pip install --upgrade black`,
107107
`pip install --upgrade flake8`, and `pip install --upgrade isort`.
108108

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

111117
This project follows [Google's Open Source Community Guidelines](https://opensource.google/conduct/).

0 commit comments

Comments
 (0)