-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
44 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|
||
|