Skip to content

Commit e017d8e

Browse files
committed
Update per DK comments
1 parent 5977220 commit e017d8e

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,11 @@ If any static analysis tools such as Pylance fail, try installing the package wi
3333

3434
### Testing
3535

36-
> Note: We use [pytest](https://docs.pytest.org) to write tests for new client code. However, many older tests use [unittest](https://docs.python.org/3/library/unittest.html). These commands run the `pytest` and `unittest` tests.
36+
To set up the testing environment, install the test requirements with:
37+
38+
```shell
39+
pip install -r requirements-test.txt
40+
```
3741

3842
There are three kinds of tests:
3943
- Unit tests test individual client components.
@@ -63,7 +67,7 @@ pytest test
6367
> We strongly recommend using [pre-commit](https://pre-commit.com/) to automatically run all linters locally on each commit. Install `pre-commit` on your system, and then enable it with `pre-commit install`.
6468
6569
We use the following tools to ensure a high code quality:
66-
- black (formatter), run with `black $FOLDER_WITH_CHANGES`
70+
- ruff (formatter), run with `ruff format $FOLDER_WITH_CHANGES`
6771
- flake8 with plugins. Run with `flake8 $FOLDER_WITH_CHANGES`.
6872

6973
Note that all plugins are listed in the `requirements-devel.txt` file and are installed in the first step.

0 commit comments

Comments
 (0)