README.md

CulturePlex Guidelines

Best practices to help CulturePlex developers

Index

• Quality guidelines

  • Basic principles
  • Specific guidelines
    • Python
    • HTML
    • CSS
    • Javascript

• Technical guidelines

  • Editor/IDE
  • Git

Quality guidelines

Basic principles

Encoding

You should always use UTF-8 for every document.

Indentation

You should use spaces instead of tabs. But never mix both of them. Use 4 spaces for Python, and 2 or 4 spaces for HTML, CSS and Javascript.

Comments

Please, comment your code. You don't need to comment every single line! Just add a comment only when you think it would be useful for other developers.

Specific guidelines

Python

HTML

CSS

• Try to keep the CSS separate from your HTML, placing it in a separate file.

Javascript

Technical guidelines

Editor/IDE

Git