23 lines (16 loc) · 574 Bytes

Contributing

Thanks for taking a look. Small, focused PRs are easiest to review.

Setup

cargo build --release
cargo test
cargo fmt
cargo clippy

Guidelines

Do not commit secrets, API keys, or machine-specific absolute paths
Prefer clear error messages over silent fallbacks when mlx-vlm / Python is missing
Keep the LAN reader (assets/lan-reader.html) dependency-light (CDN libs only if needed)
Match existing style; run cargo fmt before opening a PR

Testing

Unit tests should not require MLX, GPU, or network access to Hugging Face.