Skip to content

Contributing¤

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Environment setup¤

You only need two tools, uv and Copier.

python3 -m pip install --user pipx
pipx install uv
pipx install copier

Then you can clone the repository, enter it and set it up with:

git clone https://github.com/pawamoy/copier-uv
cd copier-uv
make setup

Running tests¤

To run the tests, use:

make test

Serving docs¤

To serve the docs locally, use:

make docs