Skip to content

Code Quality Guide

We share the common code quality standards between all Gufo Labs projects.

Python Code Formatting

All Python code must be formatting using Black code formatter with settings defined in the project's pyproject.toml file.

Python Docstrings

All Python functions and methods must be documenting using Google docstrings format.

Python Code Linting

  • All Python code must satisfy PEP8 standards.
  • Code must not contain unused imports.
  • Code must not contain unused variables.
  • Code must not use l variable or function names.

All python code must pass Flake8 tests.

Python Code Static Checks

All python code must pass Mypy type checks in the strict mode.

Test Suite Coverage

The test suite must provide 100% code coverage whenever possible.

Documentation Standards

  • Documentation must be clean and mean.