Contributing¶
Thanks for considering a contribution.
The full contributor guide lives in CONTRIBUTING.md at the repo root. Highlights:
- Setup:
pip install -e ".[dev]"thenpre-commit install - Tests:
pytest(36 tests today) - Lint + types + format:
ruff check . && ruff format --check . && mypy src/engine - Conventional Commits:
feat:,fix:,refactor:,docs:,test:,chore: - One concern per PR
Add a provider checklist¶
- Implement
engine.llm.<name>_provider.pymatchingLLMProviderProtocol - Add unit tests in
tests/test_llm_<name>.pymirroringtests/test_llm_gemini.py - Add SDK as optional dep in
pyproject.toml:[project.optional-dependencies] <name> = ["sdk>=x"] - Document in
docs/providers/index.md(both EN +.pt.md) - Add CHANGELOG entry under
[Unreleased]
Reporting bugs¶
GitHub issue with: Python version, OS, template-engine version, minimal repro, expected vs actual behavior.
For security issues see SECURITY.md.