CONTRIBUTING.md

How to contribute?

Tip

This package is part of the ComPWA Organization. For more information about how to contribute to the packages, go to compwa.github.io/develop!

To contribute to the project, you need to install the package in a virtual environment. This can be done best with uv (see installation instructions here). For this, you first need to get the source code with Git:

git clone https://github.com/ComPWA/ampform-529
cd ampform-529

Now it's simply a matter of creating and activating the virtual environment with uv sync. The dependencies for the project are 'pinned' in each commit through the uv.lock file.

uv sync --all-extras
source .venv/bin/activate

Formatting and linting checks are automatically performed when committing changes. This is done with prek, a drop-in replacement for pre-commit that reads the same .pre-commit-config.yaml file. To install the hooks in your local repository, install prek with uv:

uv tool install prek --force-reinstall

and run prek install once:

prek install --prepare-hooks

Poe the Poet is used as a task runner. Install it globally (within your home folder) with uv:

uv tool install poethepoet --force-reinstall --python=3.14

You can see which local CI checks it defines by running

poe

For instance, all style checks can be run with

poe style