How to contribute πŸ‘

How to contribute πŸ‘#

If you want to contribute to this project, you need to install hatch on your system, then clone the depot and install the default env:

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:

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

To test the module:

hatch -e tests run tests

To build the docs:

hatch -e docs run build