Skip to content

Contributing

This project is intentionally small. Changes should improve the runtime without turning it into a full agent orchestration framework.

Workflow

  1. Keep changes focused.
  2. Add or update tests for behavior changes.
  3. Update README.md or docs/ when public APIs change.
  4. Run the local checks before opening a pull request.
uv sync --extra dev --extra openai
uv run ruff check .
uv run mypy
uv run pytest
uv run mkdocs build --strict
uv build

Run the private RAG integration test only when python-rag-framework is available:

uv sync --extra dev --extra openai
uv pip install "python-rag-framework @ git+https://github.com/lelouchzr/python-rag-framework.git@v0.1.0"
uv run pytest tests/test_rag_integration.py

Guidelines

  • Use explicit typing.
  • Prefer simple composition over new abstractions.
  • Keep components independently replaceable.
  • Avoid adding non-goals such as graphs, schedulers, services or UIs.

Documentation

Update docs when public APIs, examples or installation commands change. Keep the documentation concise and practical.