.. _contribution:
Contribution
============
Contributors are highly welcome on all levels such as new features, improvements, bug fixes, and documentation.
Please read this guide carefully to hold a certain standard in code quality.
Code style
----------
We follow the `PEP 8 -- Style Guide for Python Code `_.
Code documentation
------------------
Please document your code. Each package, module, class, and function should have a comment.
We use `Google style docstrings `_, and you can find
a great example `here `_.
For major changes, it might also be good to update the documentation you are currently reading.
It is generated with `Sphinx `_, and you can find the source files in the ``./docs`` directory.
Code tests
----------
You do write tests, don't you? They are located in the ``./test`` directory.
Commit messages
---------------
The commit messages follow the
`AngularJS Git Commit Message Conventions `_ format::
():