Skip to content

Commit

Permalink
docs: Update CONTRIBUTING.md (#544)
Browse files Browse the repository at this point in the history
  • Loading branch information
SiQube authored Sep 13, 2023
1 parent 5240e93 commit 5121607
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,8 @@ cd pymovements
pip install -e .
```

If you have a problem e.g. `command not found: pip`, check whether you have activated a virtual enviroment.


### Creating a Branch

Expand Down Expand Up @@ -125,12 +127,23 @@ We use [`flake8`](https://pypi.org/project/flake8/) for quick style checks and
[`pylint`](https://pypi.org/project/pylint/) for thorough style checks and [`mypy`](
https://pypi.org/project/mypy/) for checking type annotations.

You can check your code style by using [pre-commit](https://www.pre-commit.com). You can install `pre-commit` via pip:

```bash
pip install pre-commit
pre-commit install
```

### Testing

Tests are written using [Pytest](https://docs.pytest.org) and executed
in a separate environment using [Tox](https://tox.readthedocs.io/en/latest/).

If you have not yet installed `tox` you can do so via
```bash
pip install tox
```

A full style check and all tests can be run by simply calling `tox` in the repository root.
```bash
tox
Expand All @@ -143,9 +156,9 @@ If you add a new feature, please also include appropriate tests to verify its in
functionality. We try to keep our code coverage close to 100%.

It is possible to limit the scope of testing to specific environments and files. For example, to
only test event related functionality using the Python 3.7 environment use:
only test event related functionality using the Python 3.8 environment use:
```bash
tox -e py37 tests/events
tox -e py38 tests/events
```


Expand Down

0 comments on commit 5121607

Please sign in to comment.