Contributing
============

Initial setup
-------------

In order to contribute to the project you will need to download the
source code and be able to run it in your local machine.

.. code-block:: bash

    git clone git@code.fmartingr.com:fmartingr/jeeves


In this project we use Poetry_ to manage
the python dependencies and virtual environments. Make sure you have it
installed before continuing.

In order to install all dependencies inside a virtual environment, just
run:

.. code-block:: bash

    poetry install

Accessing a shell within the virtutalenv
-----------------------------------------

.. code-block:: bash

    poetry shell


Running the test suite
----------------------

.. code-block:: bash

    poetry run pytest .

.. _Poetry: https://poetry.eustace.io