Readme.md

Developement guidelines

If you contribute to this project please read the following guidelines first:

1. Linting
2. Commit
3. Coding style
4. Git Style
5. Reviewing
6. Project management
7. GitHub actions
8. Install python packages

Templates

Some templates are provided in doc/02_development/templates.

template_class.py

Use this class if you don't have much experience with python. If you just want to copy an empty class use template_class_no_comments.py.

template_class_no_comments.py

If you just want to copy an empty class use this class.

template_component_readme.md

This template functions a template for who to describe a component. IT should be contained in every component as Readme.md.

template_wiki_page.md

This template functions a template for who to build knowledge articles for everyone to understand. The basic structure should be kept for all articles. This template further contains a cheat sheet with the most useful markdown syntax.

template_wiki_page_empty.md

This template functions a template for who to build knowledge articles for everyone to understand. The basic structure should be kept for all articles. This template is empty and can be used straight forward.