Standards

Brezel Standards Recommendations

Coding Style

Identifier Namings (Backend / API)

  • The following items should be CamelCase: vars, methods, workflows (title, actions, …)
  • The following items should be snake_case: modules, fields, in general: “things that end up as an sql identifier (column name, table name, …)”

Names convention (Frontend / SPA)

  • A variable should start in snake_case (someVarName, some_other_var, some_Other_Var)
  • Functions have to start with a capital letter ( FunctionName(), Some_other_func(), …)

Wiki page design

---
title: "DD MONTH YEAR"
weight: LAST_MINUS_ONE
---

## Headline
Lorem ipsum dolor sit amet, consectetur adipisicing elit.