Coding standards

Coding standards

The Open Recipes project is built on Python. We follow the PEP8 coding standard for the most part. Please do your best to submit code that complies with this standard.

We skip a few of the PEP8 guidelines. The include, as broken out by pep8.py error codes:

• E127 continuation line over-indented for visual indent

• E128 continuation line under-indented for visual indent

  Indenting to the opening parentheses makes sense, but it can be problematic in some cases. Try to meet E128, but readability and reasonable line length come first.

• E501 line too long (82 > 79 characters)

  Avoid going over 79 characters unless it negatively affects readability.

Tools

A code linter/formatting checker will be very helpful in sticking to these standards. Most IDEs and code editors have some kind of add-ons for PEP8 style checking. Here are a few:

• SublimeLinter
• vim-flake8
• pep8 CLI tool
• autopep8 reformatter CLI tool