Contribution guidelines

All contibutions happen via pull-requests.

Making a pull-request

Put your contribution in a new branch. Does not matter if you work directly in this repo, or in a fork.
Before making a more complex pull-request make sure to open an issue beforehand if it does not exist yet. This allows for a preliminary discussion before the pull-request is initially submitted. This often eliminates unnecessary work.
Please, mark the PR as WIP if you plan to add some work in the future.
Pull-request requires at least one approval to be merged into master branch.
Refer to relevant issue if it's there.
Make sure the conflicts with master are resolved.
The author of the pull-request is responsible for merging it if they have sufficient privileges. This makes sense because sometimes there are conflicts.

Testing

Make sure to add/update unit tests.
Make sure to test your changes before submitting the PR. If you want to postopone the testing, you can submit you PR as WIP.

Code style

Issues

Please, check if some issues about your topic already exist before making a new issue. Continue the discussion in the old issue if it's there, or refer to it.

Checking if things work

It is encouraged to play around and check if the new features work and nothing is broken before submitting the pull-request.
The best way to do this frequently is to run the docker-compose as described in the readme.