Contributing to Djam

Coding style

  • Unless otherwise specified, follow PEP 8. Since we’re a new project, there shouldn’t be any cases (apart from those outlined here) where you need to instead conform to surrounding code.
  • Use four spaces for indentation.
  • In docstrings, use “action words”. For example, “Calculates the number of apples” rather than “Calculate the number of apples”.
  • Empty lines should not contain indentation.
  • Always use absolute imports. They’re easier to debug and are 3.0 forwards-compatible.
  • Be sure to include from __future__ import unicode_literals at the top of any file that uses strings.

Git practices

We follow the same guidelines for using git (and github) as Django, with one exception: we prefer ticket branches be named ticket/xxxx.

Read the Docs v: latest
Versions
latest
Downloads
PDF
HTML
Epub
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.