Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update CONTRIBUTING.md #544

Merged
merged 3 commits into from
Sep 13, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion 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 @@ -145,7 +158,7 @@ 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:
SiQube marked this conversation as resolved.
Show resolved Hide resolved
```bash
tox -e py37 tests/events
tox -e py38 tests/events
```


Expand Down