-
Notifications
You must be signed in to change notification settings - Fork 44
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
39 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 |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# Contributing | ||
|
||
Thanks for your interest in contributing to the parser! | ||
|
||
I no longer work on flow cytometry, so I will not personally develop any | ||
new features; howevever, PRs are welcome. | ||
|
||
Be aware that I may comandeer the PRs and refactor them a bit. | ||
|
||
## Setting up for development | ||
|
||
The package uses [poetry](https://python-poetry.org/) together with | ||
[poethepoet](https://github.com/nat-n/poethepoet). | ||
|
||
### Install dependencies | ||
|
||
```shell | ||
|
||
poetry install --with dev,test | ||
``` | ||
|
||
### List tasks | ||
|
||
```shell | ||
poe | ||
``` | ||
|
||
### autoformat | ||
|
||
```shell | ||
poe autoformat | ||
``` | ||
|
||
### unit tests | ||
|
||
```shell | ||
poe pytest | ||
``` | ||
|