40 lines (30 loc) · 1.44 KB

Contributing to Symgliph

Symgliph welcomes focused improvements to the Rust implementation, SCGP draft, conformance vectors, evaluation harness, and public documentation.

Before opening a change

Search existing issues and pull requests for overlapping work.
For protocol changes, open an issue describing the invariant, compatibility impact, and proposed schema or profile identifier.
Keep performance claims reproducible and scoped to immutable corpus, dataset, and model identities.
Never include credentials, private benchmark labels, or source material whose redistribution rights are unresolved.

Development setup

Symgliph requires Rust 1.88 or newer.

cargo test --all-features --all-targets
cargo clippy --all-features --all-targets -- -D warnings
cargo fmt --all --check
spec/validate.sh

The conformance script additionally requires jq and either check-jsonschema or jsonschema.

Pull requests

Keep each pull request centered on one reviewable outcome.
Add tests for behavioral changes and conformance vectors for protocol changes.
Update the specification before or with changes to a registered transcript, schema, or profile.
Run the complete commands above and report any intentionally skipped gate.
Preserve fail-closed behavior for digest, range, schema, and budget failures.

By submitting a contribution, you agree that it may be distributed under the repository's MIT OR Apache-2.0 license.