CONTRIBUTING.md

Contributing

Install the development environment from the repository root:

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

Keep changes focused and include regression tests for behavior changes. Before opening a pull request, run:

ruff check .
ruff format --check .
pytest

The default test command excludes tests marked training or evaluation. Mark any test that performs optimizer steps, model training, or full evaluation accordingly. Do not run or commit experiments, prepared datasets, checkpoints, or generated result trees unless that work is explicitly in scope.

Preserve deterministic seeds and paired evaluation windows when changing benchmarks. Never commit credentials, environment files, machine-specific absolute paths, or private dataset locations. Contributors are responsible for following the licenses and terms of any third-party data providers.