Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (28 loc) · 1.15 KB

CONTRIBUTING.md

File metadata and controls

39 lines (28 loc) · 1.15 KB
Raw

Contributing to EarnProof Contracts

This repository contains Soroban contracts for EarnProof issuer status, proof commitments, revocation state, and protocol configuration.

Setup

cargo build --workspace
cargo test --workspace

Validation

Run these before opening a pull request:

cargo fmt --all --check
cargo clippy --workspace --all-targets
cargo test --workspace
cargo build --workspace

Contribution Expectations

  • Keep changes scoped to the issue being solved.
  • Do not commit secret keys, seed phrases, signing material, or deployment keys.
  • Add tests for every new contract entry point or state transition.
  • Include negative tests for authorization failures and invalid transitions.
  • Keep private income data off-chain.
  • Update deployment docs and manifests when contract addresses or initialization flows change.

Definition of Done

  • Acceptance criteria are satisfied.
  • Formatting, clippy, tests, and build pass.
  • Contract storage, authorization, and event behavior are covered by tests.
  • Documentation matches actual on-chain behavior.
  • Testnet deployment evidence is updated when deployment behavior changes.