Skip to content

Coding Style

Lercerss edited this page Mar 21, 2018 · 2 revisions

Coding Style

Coding style enforced for this project is as follows:

Python

For all Python code, follow guidelines set out in PEP-8. As a general guideline, variable and function names must use under_score while classes must use camelCase.

Templates

Templates follow general guidelines set out in the W3Schools HTML5 Style Guide. For better consistency with other languages used in the project, files are indented with 4 spaces. Comments that do not need to reach the client-side must use Django Template's comment tag, i.e. {# ... #}, instead of HTML comments <!-- ... -->.

JavaScript

JavaScript files follow guidelines set out in the W3Schools JavaScript Style Guide.

CSS

CSS files follow guidelines set out in Section 4 of the Google HTML/CSS Style Guide.

Clone this wiki locally