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

If you want to contribute to this project, you need to install [`hatch`](https://hatch.pypa.io/latest/install/) on your system, then clone the depot and install the default env:

```bash
git clone https://gitlab.univ-nantes.fr/mars-rovers/marsimage.git
cd marsimage

# Install dev dependencies
hatch env create
```

To lint and format the source code:

```bash
# preview the formatting changes
hatch fmt --diff
hatch fmt
```

To test the module:

```bash
hatch -e tests run tests
```

To build the docs:

```bash
hatch -e docs run build
```