Hello fellow developer/hacker/citizen/peer!
inspired by : contributing guide of udata project
... document to finish ...
The development language is English. All comments and documentation should be written in English, so that we don't end up with “frenghish” methods, and so we can share our learnings with developers around the world.
We follow the PEP-0008 and PEP-0257 as mush as possible in the respect of PEP-0020.
On top of that, we apply the Python Style Guide from Google.
As it's still planned to migrate to Python 3 some day, try to always use a forward compatible syntax in order to ensure an easy future migration:
- unicode by default, starts any file with
from __future__ import unicode_literals
- Python 3 compatible
print
statement withfrom __future__ import print_function
- use
io.open
instead ofcodecs.open
to manipulate utf-8 files
We follow the JavaScript styleguide from airbnb.
We follow @mdo's code guide.
We try to stay as close as possible to CommonMark but use default extensions proposed by MkDocs.