Coding guidelines

Please do:

• use the common sense,
• add tests along with the new code that prove that it works:
  • when adding/changing non-trivial logic please add unit tests,
  • for all bug fixes and new features using GitLab API please add acceptance tests
• add or update the docs for new features,
• use pre-commit to automatically reformat your code and run linters before committing,
• squash your commits (unless there is a reason not to),
• follow conventional-commit format in order to produce consistent human and machine-readable commit messages, making it easier for maintainers to produce the CHANGELOG.

We are very open to refactoring but in case of bigger efforts we suggest creating an issue first and discussing what you propose to do before doing it.