Skip to content

Latest commit

 

History

History
27 lines (16 loc) · 954 Bytes

linting.md

File metadata and controls

27 lines (16 loc) · 954 Bytes

Linting

Summary: To ensure unified standards in the project, the following linters are applied during commit.

🐍 Python conventions

To enforce unified standards in all python files, we use Flake8, which is a wrapper for the following three tools:

  • PyFlakes
  • pycodestyle
  • Ned Batchelder’s McCabe script

More details on it can be found in the documentation of Flake8.

We also use black as a code formatter to unify the coding style.

💬 Markdown Linter

To enforce unified standards in all markdown files, we use markdownlint-cli. More details on it can be found in the according documentation.

🚨 Common Problems

Currently, we are not aware about any Problems.