Contributing

Before getting involved please carefully read our documentation for Open Source Software contributions. Be aware that we can only consider pull requests of authors who consider 52North’s CLA guidelines and, in particular, fill the 52North Contributor License Agreement.

General remarks

Please do not ask if you can work on an issue. Contributions are welcome. Remember to read the CLA guidelines.
Be aware that we do not assign issues to contributors we have not worked with yet. If this applies to you please do not ask to be assigned.

Style guide

Follow the recommendations from PEP 8 – Style Guide for Python Code.

Docstring

Docstrings should use the reStructuredText (reST) format. For details see, e.g., this stackoverflow question, the Sphinx + ReadTheDocs documentation or the example below.

Example:

def my_function(param1):
    """
    This is a reStructuredText style.

    :param param1: first param
    :type param1: type of first param
    :return: description of what is returned
    :rtype: type of return value
    :raises keyError: raises an exception
    """