Coding Standard

⚠️ In progress

REST

TODO ideas: https://opensource.zalando.com/restful-api-guidelines/#100

Java

TODO: maybe https://google.github.io/styleguide/javaguide.html

Python

The coding standard is the Python regular PEP 8. It's enforced by pre-commit hooks like black

Public interfaces

Any backwards compatibility guarantees apply only to public interfaces. Public interfaces are modules and packages defined or imported in vdk.api.*. unless the documentation explicitly declares them to be provisional or internal interfaces. Anything else is considered internal. All public interfaces (classes or methods) must have documentation.