Contributing

[pozsa]

This issue is meant to document our development practices, git workflow and other related topics. We should add these items to the repo in the form of a contributing guide.

[sbliven]

I suggest

• black and flake8 for formatting
• pytest and tox for testing
• sphinx with myst-parser (markdown) for docs
• github actions for CI

I usually just use setuptools for packaging, but I'd be open to trying something newer (e.g. poetry).

[pozsa]

I'm ok with everything you mentioned above. I would add isort and mypy. For packaging, I'd use docker, but I like the idea of using poetry for python dep management.

[pozsa]

Have you seen this https://github.com/github/super-linter? I suggest we hook it up and disable pylint.

[sbliven]

Yes to all of that

[pozsa]

How thorough do we want to be with docstrings? E.g. do we want pydocstyle?