CONTRIBUTING.md

Contributing

Thanks for contributing to turboagents.

Development Setup

This repository uses uv as the default Python workflow.

uv sync

Useful variants:

uv sync --extra rag
uv sync --extra mlx
uv sync --extra vllm
uv sync --all-extras

Common Commands

Run the test suite:

PYTEST_DISABLE_PLUGIN_AUTOLOAD=1 uv run python -m pytest -q

Build the package:

uv build

Serve the docs locally:

uv run mkdocs serve

Build the docs:

uv run mkdocs build

Pull Requests

• Keep changes focused and scoped.
• Add or update tests when behavior changes.
• Update docs and changelog entries when user-facing behavior changes.
• Do not include unrelated refactors in the same pull request.

Release Process

• Update the version in pyproject.toml.
• Update CHANGELOG.md.
• Build locally with uv build.
• Publish explicitly with uv publish when you are ready.

Publishing is a manual action. This repository does not auto-publish to PyPI.