Skip to content

Contributing

Setup

git clone https://github.com/sophiaconsulting/parot.git
cd parot

rustup update stable
just setup             # installs Python deps + builds the native extension
just setup-hooks       # optional: fmt check on commit, full test on push
just wasm-build        # optional: WASM bindings

# Optional: preview the docs site
pip install mkdocs-material
mkdocs serve           # http://localhost:8000

Tests

just test          # Rust + Python + JS
just test-rust
just test-python
just test-js

Benchmarks

just bench-all         # full suite
just bench-query-scaling   # headline 10/100/1k/10k/100k phrase sweep
just bench-readme      # WASM headline

Results land in benchmark/output/ as JSON. See Benchmarks for methodology.

Pull requests

  • Run just test before submitting.
  • If changing benchmark-visible code, run just bench-all and commit updated benchmark/output/{chip}/.
  • One logical change per commit.