Contributing to Hope Documents

We welcome contributions to Hope Documents! This guide will help you get started with setting up your development environment.

Cloning the Repository

First, clone the repository to your local machine:

git clone https://github.com/unicef/hope-documents.git
cd hope-documents

We use tox to manage the development environment and ensure consistency. Make sure you have tox installed:

pip install tox

To run the test suite, use the following command:

tox -e d52-py313

To check for code style and linting errors, run:

tox lint

To build the documentation locally, use:

tox docs

The documentation will be generated in the ~build/docs directory.