Contributing

Thank you for your interest in Plugboard. Contributions are welcomed and warmly received! For bug fixes and smaller feature requests feel free to open an issue on our Github repo. For any larger changes please get in touch with us to discuss first.

😻 PR process

We use Conventional Commits on our main branch, so prefix your pull request titles with a commit type: feat, fix, chore, etc.

💻 Development setup

For small changes or to get up-and-running quickly, we recommend GitHub codespaces, which provides you with a ready-to-use development environment.

For local development we recommend VSCode.

Python dependencies

Dependencies are managed using uv. Install the project using

uv sync --all-extras --group test --group docs

Testing

Tests are run in pytest, which you can run with

uv run pytest .

Linting

We use ruff for code formatting and style. Install the pre-commit hook by running

uv run pre-commit install

Documentation

The package documentation uses Material for MkDocs and can be viewed locally by running

uv run mkdocs serve

Building example models

This repo includes a custom LLM prompt for the examples folder. If you use GitHub Copilot, this can help you build a Plugboard model from a description of the process and/or the components that you would like to implement. We recommend using Copilot in agent mode and allowing it to implement the boilerplate code from your input prompt.