Developer Guide
Contributing
Guidelines for developing and contributing to Inferia LLM
We welcome contributions! This guide will help you set up your development environment and understand our workflows.
Development Workflow
- Fork and Clone: Start by forking the repository and cloning it locally.
- Install Dependencies: Install the development dependencies for the
inferiapackage.pip install -e ".[dev]" - Create a Branch: Always work on a feature branch (
feat/new-adapter,fix/login-bug).
Code Style
We enforce code quality using standard Python tooling.
- Formatter: We use
blackfor code formatting.black . - Linter: We use
ruff(orflake8) for linting. - Type Checking: Type hints are strongly encouraged.
Running Tests
We use pytest for our test suite.
# Run all tests
pytest
# Run tests with coverage
pytest --cov=inferiaPull Requests
- Push your branch to your fork.
- Open a Pull Request against the
mainbranch. - Ensure all CI checks pass (linting, tests).
- Provide a clear description of your changes.