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

Clarification on access modifiers

Python uses _ symbol to determine the access control for a specific data member or a member function of a class

• Public methods have not _ prefix
• Protected methods or attributes have single underscore '_' as prefix (for example _execute_protected()
• Private methods or attributes have double underscore '__' as prefix (for example __execute_private())

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.