Style guidelines - ab-10/WSROV GitHub Wiki

Python

For writing code in python use 4 spaces long, soft tabs. Capitalize only variables with constant values, use snake case for multiword variable names and generally use meaningful variable names. Follow PEP-8 guidelines (using a plugin that automatically checks for PEP-8 is recommended).

For automatic documentation we use pyDoc which extracts documentation from docstrings, because of this it is important to write descriptive docstrings for method and class definitions. In addition to pyDoc we use pydoc-markdown to extract the documentation in markdown format.

For automated testing of code written in Python we use pyTest as the base of the test. Additionally, we use socat for mocking serial ports.

Git

We (obviously) use Git with Github for easier collaboration between team members.

When programming commit every change, write commit messages in imperative mood (spoken or written as if giving a command or instruction). Recommended reading: How to Write a Good Commit Message.