Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (29 loc) · 1.21 KB

CONTRIBUTING.md

File metadata and controls

40 lines (29 loc) · 1.21 KB
Raw

Contributing to WaveFlow

WaveFlow automates bounty escrow on Stellar/Soroban with GitHub merge-triggered payouts.

Before you start

  1. Read docs/PRD.md for product scope.
  2. Read docs/ROADMAP.md for phase plan.
  3. Walk through docs/core-loop.md for the merge-to-payout path.

Development setup

git checkout main && git pull
git checkout -b feature/your-change
cp .env.example .env
docker-compose up -d
cargo build --workspace
cargo test --workspace

Workspace layout

Crate / path Role
contracts/waveflow-escrow Soroban escrow contract
crates/gateway GitHub webhooks and chain attestation
crates/api REST API for programs and payouts
crates/shared Config, types, errors

Pull requests

  • Branch from main, open PRs against main.
  • Run cargo fmt, cargo clippy, and cargo test --workspace before pushing.
  • Use issue prefixes: [contracts], [backend], [documentation], [infra].
  • Label Drips Wave issues with Drips Wave and complexity:*.

Security

Never commit real webhook secrets or Stellar secret keys. See docs/security-checklist.md.