Contribute

Contributions are more than welcome! Submit a pull request, or open an issue and I (Martin) will gladly answer your questions on how to contribute.

Setup a development environment

1. Clone this repository. git clone https://github.com/Bravos-Power/pyoframe

2. Install the dependencies. pip install --editable .[dev,docs]

3. Install the pre-commit hooks. pre-commit install

4. Run pytest to make sure everything is working. If not, open an issue!

Documentation

We use Material Docs for documentation with several plugins to enable features like automatically compiling the docstrings into the reference API. Please follow the Google style for docstrings.

Helpful commands

• pytest --cov: Runs all the tests and generate coverage information.
• mkdocs serve: Generates the documentation locally. Navigate to http://127.0.0.1:8000/pyoframe/ to check it out.
• coverage html: Generate a webpage to view the coverage information generated by pytest.