Skip to content

Latest commit

 

History

History
26 lines (18 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

26 lines (18 loc) · 1.46 KB
Raw

How to contribute?

Open in Visual Studio Code

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/actions
cd actions

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
source .venv/bin/activate

Formatting and linting checks are automatically performed when committing changes. This is done with pre-commit. To install the hooks in your local repository, run pre-commit install once:

pre-commit install --install-hooks