doc/dev/coding_standards_css.rst
author Rémi Cardona <remi.cardona@logilab.fr>
Fri, 18 Sep 2015 11:54:12 +0200
changeset 10706 b261d90149d0
parent 10492 68c13e0c0fc5
child 12370 b3084ae2e718
permissions -rw-r--r--
[server] Port BFSS to py3k The BFSS API changes in python 3: * 'defaultdir' MUST be a unicode object * 'fsencoding' MUST NOT be set In python 2, fsencoding handles both the encoding of file paths on the file system (utf-8 by default, but the system may actually be using something else) and the encoding of file paths that will be stored in the database. So in python 3, we wipe the slate clean: * rely on sys.getfilesystemencoding() to convert unicode objects to bytes * always encode paths to utf-8 for storage in the database Caveat emptor / here be dragons: * sys.getfilesystemencoding() depends on the current locale, which therefore MUST be set properly * when migrating an existing instance from py2 to py3, one MAY need to reencode file paths stored in the database

CSS Coding Standards
--------------------

(Draft, to be continued)

:Naming: camelCase

Indentation rules
~~~~~~~~~~~~~~~~~
- 2 espaces avant les propriétés

- pas d'espace avant les ":", un espace après

- 1 seul espace entre les différentes valeurs pour une même propriété


Documentation
~~~~~~~~~~~~~
Please keep rules semantically linked grouped together, with a comment about
what they are for.

Recommendation
~~~~~~~~~~~~~~
- Try to use existing classes rather than introduce new ones

- Keep things as simple as possible while in the framework

- Think about later customization by application

- Avoid introducing a new CSS file for a few lines of CSS, at least while the
  framework doesn't include packing functionalities