Skip to content

Code conventions#

We follow the principles of consistency and readability. Code-style is controlled by few linter jobs in GitHub Actions.

  1. Pycodestyle
  2. Pylint
  3. Black

Pycodestyle#

  • Protects the code from violations of agreed rules.
  • Ignores E402,E731 rules for now.

Pycodestyle-full-report#

  • Prints a full report of pycodestyle rule violations, including not agreed yet.

Pylint#

  • Protects the code from violations of agreed rules.
  • Lints all agreed rules configured in .pylintrc
  • Ignores list of rules which are not agreed yet .pylint-disabled-rules

Pylint-full-report#

  • Lints all agreed rules configured in .pylintrc
  • Prints a full report of pylint rule violations, including not agreed yet.

Black#

  • Lints default black rules except "string normalization".
Last update: 2023-03-13
Created: 2023-02-27