Guidelines

  • Use Google docstrings everywhere. The documentation in “doc” is generated with Sphinx using just doc.

  • Write tests for every method/function which manipulates data.

  • Have a look at the Justfile and the available just recipes.

  • Use typehints when declaring a function, class or method.

  • VS code settings in the dev container take care of linting with mypy, ruff and code formatting with black.