You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Problem
DESIGN.md and README.md use terms like nullifier, commitment, Merkle root, UltraHonk, keccak transform, and Poseidon2 throughout, assuming ZK familiarity. This raises the bar for new contributors who understand Stellar/Soroban but not zero-knowledge cryptography, or vice versa.
Proposed change
Add a short GLOSSARY.md defining the ~15 most-used domain terms in the codebase in one or two plain-English sentences each, linked from README/CONTRIBUTING.
Acceptance Criteria
GLOSSARY.md covers the core terms used across README/DESIGN.md (nullifier, commitment, Merkle root, recipient binding, UltraHonk, Poseidon2, selective disclosure, relayer, etc.)
Linked from README.md and/or CONTRIBUTING.md
Relevant tests (just test, pnpm test, cargo test, or nargo test as applicable) pass locally and in CI
A screenshot or short screen recording is attached to the PR showing the change working (the rendered glossary) — required before this can be merged.
Open your PR against the dev branch, not main. All active development merges into dev.
Area
repo root or docs/
Problem
DESIGN.md and README.md use terms like nullifier, commitment, Merkle root, UltraHonk, keccak transform, and Poseidon2 throughout, assuming ZK familiarity. This raises the bar for new contributors who understand Stellar/Soroban but not zero-knowledge cryptography, or vice versa.
Proposed change
Add a short
GLOSSARY.mddefining the ~15 most-used domain terms in the codebase in one or two plain-English sentences each, linked from README/CONTRIBUTING.Acceptance Criteria
just test,pnpm test,cargo test, ornargo testas applicable) pass locally and in CIOpen your PR against the
devbranch, notmain. All active development merges intodev.Discuss this issue / coordinate work: join the DShield contributor Telegram group: https://t.me/+SiGHH24No9U2MDJk