Documentation improvements
There are a couple of dev documentation-related things that we should improve:
-
Explain how to run tests in the Readme (so that people can remove bugs locally before running final tests on our runners) -
Add proper GitLab shields like in https://git.tu-berlin.de/dima/isda/isda-streaming that show test pipeline status and code coverage on the main project page -
Remove/update outdated Readme content -
Write docstrings for each module, class, and function