Next: , Up: Contribution Guidelines   [Contents]

3.1 Conventions


Try to keep the file readable.


Characters on a line shouldn’t exceed 100 characters.


Make sure you don’t have code commented out during commit. Uncomment them or remove them completely.


Do not add comments following the code, add them to the top of the code. It makes it harder to read, and lines longer. Here is an example:

# Good way of commenting.
your code goes here

your code goes here  # Avoid this way of commenting.