============
Contributing
============

Contributions are welcome, preferably via pull request. Check the GitHub issues to see
what needs work, or if you have an idea for a new feature it may be worth raising an
issue to discuss it first.


Installing
==========

The easiest way to work on this is to fork the project on GitHub, then check it out and
set it up::

    git clone git@github.com:USERNAME/runchain.git
    cd runchain/
    uv venv .venv
    source .venv/bin/activate
    uv pip install -r tests/requirements.txt
    pre-commit install

(replacing ``USERNAME`` with your username).

This will install the development dependencies too.


Running locally
===============

You can now run the local installation from your repository root with::

    python -m runchain <cmd> [<options>]


Testing
=======

It's always easier to merge PRs when they come with tests.

Run the tests with pytest from your repository root::

    pytest