Skip to content

Commit

Permalink
Fix contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
JCZuurmond committed Jun 2, 2024
1 parent 96551ca commit 1a8a5f2
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ For a conda environment do:

``` bash
conda activate <env-name>
pip install -e .[dev]
pip install -e .[test]
```

## Venv
Expand All @@ -23,7 +23,7 @@ For a pip environment do:
``` bash
python -m venv venv/
source ./venv/bin/activate
pip install -e .[dev]
pip install -e .[test]
```

# Testing
Expand Down Expand Up @@ -83,7 +83,7 @@ using:
pytest tests/
```

Unit tests are the lowest level op tests, and should test isolated pieces of
Unit tests are the lowest level of tests, and should test isolated pieces of
code. For example, testing an Apache Spark UDF is a perfect example:

```python
Expand All @@ -102,7 +102,7 @@ def test_add_udf():
assert add(19, 25) == 44
```

For example, if someone writes a nicely complex regular expression, than you
For example, if someone writes a complex regular expression, then you
want to make sure that it is properly covered by unit-tests. The `spark_session`
is automatically generated in the background thanks to the
[`pytest-spark`](https://pypi.org/project/pytest-spark/) package.

0 comments on commit 1a8a5f2

Please sign in to comment.