1. Style and Idiomatic Code

These pages describe the style used to write code, together with the idiomatic way of implementing different things.

The content might be nitpicking, but we hope that by following these guide you will find easier to collaborate and improve the quality of your contribution to the project.

• 1.1. Generic Style Guide
  • 1.1.1. General
  • 1.1.2. Comments
  • 1.1.3. Feature branch development
• 1.2. Python
  • 1.2.1. General
  • 1.2.2. Abstract
  • 1.2.3. Mixin
  • 1.2.4. Project specific
• 1.3. Bash
  • 1.3.1. General
  • 1.3.2. Path constants
  • 1.3.3. Function Definition
  • 1.3.4. Case Syntax
  • 1.3.5. IF/THEN/ELSE
  • 1.3.6. FOR
  • 1.3.7. WHILE/UNTIL
  • 1.3.8. References
• 1.4. CSS and Styles
  • 1.4.1. CSS Syntax Elements
  • 1.4.2. General
  • 1.4.3. CSS Class naming
  • 1.4.4. Rules definition
  • 1.4.5. Layout and Typography separation
  • 1.4.6. Tailwind and PostCSS
• 1.5. HTML, XML and other markups
  • 1.5.1. General
  • 1.5.2. CSS interaction
  • 1.5.3. HTML tags usage
• 1.6. JavaScript
  • 1.6.1. General
  • 1.6.2. Prevent polluting the global scope
  • 1.6.3. Defining classes
  • 1.6.4. CSS interaction
  • 1.6.5. Test styleguide
• 1.7. Documentation
  • 1.7.1. General
  • 1.7.2. Annotations