====================
How to contribute
====================

General informations
---------------------------------------

Contributions should include tests and an explanation for the changes they
propose. Documentation should be added.

Testing
--------------

This projects use `unittest`_ to automate testing. Add tests to ``BioPlate/tests/`` folder. Before submeting your change, make sure everything work proprely by running ``BioPlate/tests/run_all_test.py``

.. _`unittest`: https://docs.python.org/3/library/unittest.html

Documentation
----------------------------

If you made change on existing function, you should update documentation accordingly. Else, you should create a new `.rst` file with useful informations as you would like read as end user.