Contributor Guide

Thank you for your interest in contributing to this project! Below are some guidelines and requirements to collaborate effectively.

Prerequisites

Before making your first commit, make sure you have the following tools installed:

Install pip

curl "https://bootstrap.pypa.io/get-pip.py" >> get-pip.py && python3 get-pip.py

Include this in your PATH
```
export PATH=$PATH:$HOME/.local/bin
```
Install Poetry
```
pip install poetry
```
At the root of the project, activate the Python environment.
```
poetry shell
```
Install the Python dependencies
```
poetry install
```

To ensure code quality, we use Git hooks to run flake8 before every commit. Follow these steps to install the pre-commit hook:

Assign execution permissions to the script (only needed once after cloning the repository):
```
chmod +x ./scripts/install-hooks.sh
```
Run the script:
```
./scripts/install-hooks.sh
```