Thanks for taking the time to read this!
The EOS project is in early development, therefore we encourage contribution in the following ways:
Please report flaws or vulnerabilities in the GitHub Issue Tracker using the corresponding issue template.
Please first discuss the idea in a GitHub Discussion or the Akkudoktor Forum before opening an issue.
There are just too many possibilities and the project would drown in tickets otherwise.
We welcome code contributions and bug fixes via Pull Requests. To make collaboration easier, we require pull requests to pass code style and unit tests.
Our code style checks use pre-commit.
pip install -r requirements-dev.txtTo run formatting automatically before every commit:
pre-commit installOr run them manually:
pre-commit run --all-filesUse pytest to run tests locally:
python -m pytest -vs --cov src --cov-report term-missing tests/