Skip to content

Contributing

Prerequisites#

You'll need the following prerequisites:

  • Python 3.11
  • venv or other virtual environment tool
  • git
  • tox

Run tests and linting#

Run tests and linting locally to make sure everything is working as expected.

# Run automated code formatting and linting
tox run -m test

Code style#

Est Shizard uses Black code formatter.

It is recommended to integrate it with your IDE so that formatting occurs when saving.

To format your code from the terminal, run:

black .

Documentation style#

Documentation is written in Markdown and built using Material for MkDocs. API documentation is build from docstrings using mkdocstrings.

Code documentation#

When contributing to Est Shizard, please make sure that all code is well documented. Code should be documented using properly formatted Google-style docstrings