Skip to content

contributing.md

Latest commit

 

History

History
152 lines (97 loc) · 2.27 KB

contributing.md

File metadata and controls

152 lines (97 loc) · 2.27 KB

Contributing

Thanks for contributing to llm-gateway-bench.

This guide focuses on:

  • setting up a development environment
  • running tests and linters
  • contributing docs

If you are looking for the repository-level contributing doc, also see CONTRIBUTING.md at the repo root.

Development setup

Prerequisites

  • Python 3.9+
  • Git

Optional but recommended:

  • uv (fast Python env management)

Clone

git clone https://github.com/mnbplus/llm-gateway-bench
cd llm-gateway-bench

Create an environment

Using venv:

python -m venv .venv

# macOS/Linux
source .venv/bin/activate

# Windows PowerShell
.\.venv\Scripts\Activate.ps1

Install editable + dev deps:

python -m pip install -U pip
python -m pip install -e ".[dev]"

Run tests

pytest

With coverage:

pytest --cov

Linting & formatting

  • Format: black
  • Lint: ruff
  • Types: mypy

Suggested commands:

ruff check .
black .
mypy src

Working on documentation

Build docs locally

python -m pip install -e ".[dev]"
mkdocs serve

Open http://127.0.0.1:8000.

Documentation style

  • Prefer short sections and runnable snippets
  • Use stable relative links between pages
  • Avoid provider marketing claims; document steps + gotchas

Adding or improving providers

Provider defaults live in src/llm_gateway_bench/providers.py (PROVIDER_DEFAULTS).

Before adding a provider:

  1. Verify the endpoint is OpenAI-compatible
  2. Confirm the correct base URL
  3. Identify the environment variable name for API key
  4. Add notes to Providers

PR checklist

  • Tests pass (pytest)
  • Lint passes (ruff check .)
  • Formatting applied (black .)
  • Updated docs for user-facing changes
  • Changelog entry if behavior changes

Commit messages

Use conventional, readable messages. Examples:

  • docs: improve provider setup examples
  • feat: add report json output
  • fix: handle streaming usage missing

Security and secrets

  • Never commit real API keys
  • Use .env locally and GitHub Secrets in CI

Getting help

Open an issue with:

  • provider name + base URL
  • model id
  • a minimal command that reproduces the bug
  • sanitized error output