How to contribute

Contributions are welcome! Simply submit a pull request on GitHub with your changes and they will be reviewed. Or open an issue to start a discussion before working on changes.

How to setup a development environment

Install the dependencies: pip install --editable .[dev,docs]
Run pytest to make sure everything is working. If not, open an issue!

Some helpful commands

pytest: Runs all the tests. Tests are found under /tests and also as doc tests. Include the flag --cov to get test coverage information.
mkdocs serve: Generates the documentation locally. Navigate to http://127.0.0.1:8000/pyoframe/ to check it out.