Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
56 lines (40 loc) · 1.15 KB

CONTRIBUTING.md

File metadata and controls

56 lines (40 loc) · 1.15 KB

Contributing to Handler

Prerequisites

  • Python 3.11+
  • uv for dependency management
  • just for running commands
  • Ollama (optional, for running the server agent)

Setup

git clone https://github.com/alDuncanson/handler.git
cd handler
just install

Development

Run just to see all available commands.

Common Commands

just check    # Run lint, format check, and typecheck
just fix      # Auto-fix lint and format issues
just test     # Run tests

Running Handler Locally

uv run handler --help       # Run any CLI command
uv run handler tui          # Launch the TUI
uv run handler server agent # Start the reference agent (requires Ollama)

Working on the docs

The Mintlify docs source lives in docs/.

npm i -g mint
cd docs
mint dev

When the Mintlify GitHub app is connected to this repository, pushes to the default branch redeploy the docs automatically.

Code Style

  • Formatting: ruff format
  • Linting: ruff check
  • Type Checking: ty check
  • Testing: pytest