Style Guidelines

This documentation contains a short summary of the coding style guidelines used in VarFish.

RestructuredText

  • follow the current state

  • put two new lines before each heading

  • put each sentence on its own line (it is a semantic unit and should appear as such in revision control)

  • add labels to each section consisting of _${file_name}_${section_short}

  • use double-underscore links to prevent collisions

Python

  • see linting configuration in varfish-server/backend

  • black code style, line length 100

  • use isort

  • use flake8

TypeScript

  • see ESlint configuration in varfish-server/frontend

Rust