CONTRIBUTING.md

Requirements

Install the following tools prior to development:

• Python 3.11+
• Node.js 18+
• uv
• just

Development Setup

1. Install development dependencies:

uv sync

2. Install pre-commit hooks:

pre-commit install

3. View development recipes:

just -l

Code Style and Documentation

The project uses:

• ruff for code formatting
• embedme to maintain code examples in the README

To format code and update documentation:

just format  # Format code with ruff
just embedme  # Update code examples in README

Docker Development

A Dockerfile is provided if you prefer to develop inside a container.

To get started build the container:

docker build -t promptic .

You can then run just commands on the image

docker run --rm --env-file .env promptic test