Skip to content

Latest commit

 

History

History
59 lines (36 loc) · 1.98 KB

CONTRIBUTING.md

File metadata and controls

59 lines (36 loc) · 1.98 KB
Raw

Contributing guide

Hello fellow developer/hacker/citizen/peer!

inspired by : contributing guide of udata project

... document to finish ...

Language

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.

Code guides

Python style guide

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.

Python 3 forward compatible syntax

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 with from __future__ import print_function
  • use io.open instead of codecs.open to manipulate utf-8 files

JavaScript style guide

We follow the JavaScript styleguide from airbnb.

HTML and CSS code guide

We follow @mdo's code guide.

Documentation syntax

We try to stay as close as possible to CommonMark but use default extensions proposed by MkDocs.