# Contributing

Reports and measured improvements from more Apple silicon configurations are
welcome. Open an issue with the command, variant, chip/GPU-core count, unified
memory, macOS version and generated JSON record. Remove private prompt or
reference-image content before sharing it.

For a local development environment:

```bash
uv venv --python 3.12
source .venv/bin/activate
uv pip install -e '.[dev]'
python -m pytest -q
ruff check .
ruff format --check .
python -m build
python tools/check_release.py dist/*.whl dist/*.tar.gz
```

The full numerical suite needs an Apple GPU. Portable tests run on Linux in
CI; exact M5-kernel tests skip on other hardware. The tested macOS dependency
snapshot is [requirements-macos.lock](requirements-macos.lock).

For arithmetic or loading changes, compare matching prompt, seed, canvas,
noise stream and variant, and retain image/trace hashes. Distinguish warm
resident timings from first-load timings, and MLX allocations from process
physical footprint. [Benchmark method](BENCHMARKS.md).

Keep this repository inference-only. Do not submit training, model conversion,
packing encoders, online quantization, weight exporters, checkpoints, private
publishing tools or credentials. The source and distribution audit checks
reviewed module names and conversion operations. Public sample images remain
in the existing access-reviewed Hub gallery under the model terms.

Changes to the CLI, model catalog or numerical behavior should update the
usage/validation documents and include a focused regression test where useful.