JavaScript

We follow the Airbnb JavaScript style guide. The only difference is that we are using four spaces indentation instead of two, for a better readability.

Naming Conventions

• For variables see the naming conventions of the Style Guide.
• UPPERCASE naming is fine but should not be overused. Not every variable that is declared with const should be uppercase. But it’s fine to use UPPERCASE for constants on a module level that are considered configuration variables. The common sense of the developer should decide this individually.
• We use the $ prefix for variables that hold jQuery objects or collections.
• Files should be named in snake case.
• Test files should end on *.spec.js, for example some_functionality.spec.js.
• All test files should live in a specs directory. In a Django application this directory should live inside the static/js or static/appname/js directory in every app. In a standalone JavaScript application the specs directory should be placed on the same level as the src directory.

Documentation

• Functions/methods/classes that are not self-explaining should be documented by writing comments as described in Airbnb Style Guide.