Code Conventions

• Python: Python coding convention
• Javascript: Javascript coding convention
• HTML and HTML-based Templates: Django template coding convention

General conventions

Language

• executable code: American English (color, optimize, dialog)
• docstrings / comments: Canadian/British English (colour, optimize or optimise, dialog or dialogue)
• HTML: Canadian English for strings, American English for tags, properties, attributes

URIs & Folders

We try to mimic our directory structure in our URIs.

/s/shopify/beta is in /apps/sibt/shopify/templates/beta.html

/admin/* is in /apps/admin/__.py

/about is in /apps/homepage

Git

Commit message

Keep in format of:

{Present tense verb} one-liner about the commit

- change #1
- change #2
- change #3

Example:

Add SIBT mass emailer

- can only select one version
- HTML tags allowed

Review

Avoid useless comments!