Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
28 lines (23 loc) · 990 Bytes

CONTRIBUTING.md

File metadata and controls

28 lines (23 loc) · 990 Bytes
Raw

Contributing to steerbench

Thanks for your interest. This is a research repo; correctness and reproducibility come before features.

Setup

uv sync
uv run pre-commit install

Before you open a PR

  • uv run ruff check . && uv run ruff format --check .
  • uv run mypy src
  • uv run pytest -q
  • New behaviour needs a test. Stochastic results need a fixed seed and a reported mean ± std over 3+ seeds.

Good first issues

See the good first issue label (most are also tagged help wanted). Each one has a problem description, file:line pointers, and acceptance criteria including which test to add. If the tracker is empty, open an issue describing what you'd like to add and we'll scope it together.

Reproducibility rules

  • Pin versions (the uv.lock is committed).
  • Any results table states seeds, hardware, and wall-clock.