Skip to content

Commit e4207ac

Browse files
committed
docs(CONTRIBUTING): note Python dev time dependency
1 parent c9c412f commit e4207ac

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,15 @@ Also, please bear the following coding guidelines in mind:
199199
- In addition to running the test suite, there are a few scripts in the test/
200200
dir that catch some common issues, see and use for example runLint.
201201

202+
- Make sure you have Python 3.7 or later installed. This is required for
203+
running the development tooling, linters etc. Rest of the development
204+
Python dependencies are specified in `test/requirements-dev.txt` which
205+
can be fed for example to `pip`:
206+
207+
```shell
208+
python3 -m pip install -r test/requirements-dev.txt
209+
```
210+
202211
- Install pre-commit and set it up, see <https://pre-commit.com/>.
203212
That'll run a bunch of linters and the like, the same as the
204213
bash-completion CI does. Running it locally and fixing found issues before

test/requirements-dev.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Python >= 3.6.1 required here
1+
# Python >= 3.7 required here
22

33
-r requirements.txt
44

0 commit comments

Comments
 (0)