Contributing to Assay

Copied from the core repository

This page is CONTRIBUTING.md in Garkuwa-Studio/assay, copied from a local copy with changes not yet pushed. To change it, edit it there.

Thanks for helping. Assay is Apache-2.0 and accepts pull requests.

Developer Certificate of Origin

Every commit must be signed off under the DCO:

git commit -s -m "registry: add attestor removal"

This adds Signed-off-by: Your Name <you@example.com>, certifying you wrote the change or have the right to submit it under the project licence.

Setup

• Rust (version pinned in rust-toolchain.toml) with wasm32v1-none
• stellar-cli 28.x
• Node 24 LTS and pnpm 11 (corepack enable)

pnpm install
make build
make test

Rules

• make test must pass: fmt, clippy (-D warnings), cargo test, lint, typecheck, JS tests.
• Changes to status logic need tests at the boundaries: exactly 100% coverage, maximum report age, one attestor, disagreement threshold. Missing or stale data must never produce a healthy status.
• contracts/demo-pool is a testnet demo only. Never add mainnet config.
• Never commit keys, seeds or .env files.
• Add a line to CHANGELOG.md under [Unreleased].

Security issues

Do not open a public issue. See SECURITY.md.