Skip to content

Commit

Permalink
Add CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
eyurtsev authored Apr 26, 2023
1 parent 72450e7 commit 386364e
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions CONTRIBUTING.md
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
```

0 comments on commit 386364e

Please sign in to comment.