Meteoroid Contribution Guide

This document describes the guidelines to Meteoroid. If you are planning to contribute to the code you should read this document and get familiar with its content.

General principles

Contributors must adhere to the following general principles:

• Meteoroid programming language is Python.
• Using Django and restframework.
• Using OpenWhisk as a FaaS platform.
• Code contributed to Meteoroid must follow the code style guidelines in order to set a common programming style for all developers working on the code.

Code style guidelines

Meteoroid complaints to PEP8. Lint is the flake8 and plugins that depend on flake8. Using following plugins that depend on flake8.

• flake8-import-order
• flake8-quotes
• pep8-naming
• flake8-print
• flake8-eradicate

This project is setting following config of flake8.

max-complexity = 10
max-line-length = 100