Development

General development

This section is relevant for all development process, on backend, frontend and plugins.

GIT workflow

We roughly using GIT flow that means there are three kinds of GIT branches:

develop containing the current (not released) working copy
main containing the latest stable version
feature/XY something we are working on / your personal working copy

So if you start working on a new feature simply branch develop to feature/your-feature. If you think your code is ready to land into the develop branch, create a Pull-Request.

You should normally not push directly to the develop branch One exception could be a small hotfix without sideeffects.

Code style

We try to keep it simple, as such we enforce using following code styles:

Python

When writing python we follow PEP-8, more precisely we are using black with a line length of 120 characters.

ECMAScript / TypeScript

We follow the presets of prettier version 2.4 with this exceptions:

You should use single quotes
Print semicolons at the ends of statements
Line length is 100 characters
Allways use parens for arrow functions, e.g. (x) => fo

"prettier": {
    "singleQuote": true,
    "semi": true,
    "printWidth": 100,
    "arrowParens": "always"
}