Skip to content

Commit

Permalink
Instructions for environment (#47)
Browse files Browse the repository at this point in the history
  • Loading branch information
psteinb authored May 17, 2022
1 parent 15f068a commit 0111a94
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,50 @@

We invite contributions of new algorithms, tasks, and metrics. Please do not hestitate to get in touch [via email](mailto:[email protected],[email protected]) or by opening an issue on the repository.

## Setup

To create a reproducible environment, we advice our contributors to follow these steps in order to ensure comparable results when contributing a feature or bugfix. Assuming you have already created a branch from `main` and are currently working from the root of the repo, do:

```bash
python -m venv my-branch-venv
```

load this virtual environment, e.g. on \*nix or mac do:

```bash
source my-branch-venv/bin/activate
```

Upgrade pip:

```bash
python -m pip install --upgrade pip
```

Install dependencies including extras for development:

```bash
python -m pip install -e .[dev]
```

Run the tests (this currently takes quite a while):

```bash
python -m pytest -x .
```

To complete, run house keeping apps and try to make all errors disappear:

```bash
black .
```

```bash
isort .
```

Now commit and push your changes to github and open a PR. Thank you!


## Tasks

Expand Down

0 comments on commit 0111a94

Please sign in to comment.