------------
Contributing
------------
Pull requests are always welcome, and the Matrix Profile Foundation community appreciates any help you give. Note that a code of conduct applies to all spaces managed by this project, including issues and pull requests:
`Review our code of conduct! <http://matrixprofile.docs.matrixprofile.org/code_of_conduct.html>`_.

When submitting a pull request, we ask you check the following:

1. All pull requests must include, **documentation** updates, **unit tests** and `PEP-8 <https://www.python.org/dev/peps/pep-0008/>`_ compliant code standards. We also make use of `Numpy style code documentation <https://numpydoc.readthedocs.io/en/latest/format.html>`_.

2. The contributed code will fall under MatrixProfile's `license <https://github.com/matrix-profile-foundation/matrixprofile/blob/master/LICENSE>`_. Please be sure that it complies with those standards.

3. All code that is implemented from a research paper must be included within the `citations documentations <http://matrixprofile.docs.matrixprofile.org/citations.html>`_.

If you have a partial contribution, feel free to submit a pull request for review. We will help guide you in making the contribution successful! In order to get started working with this library's source code, please follow the `development installation guide <http://matrixprofile.docs.matrixprofile.org/install.html>`_ for your platform.