Skip to content

docs: add Wave label workflow to CONTRIBUTING and link from README (#38) #70

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ZacLou wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add Wave label workflow to CONTRIBUTING and link from README (#38) #70

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing to WaveFlow

WaveFlow automates bounty escrow on Stellar/Soroban with GitHub merge-triggered payouts.
WaveFlow automates bounty escrow on Stellar/Soroban with GitHub merge-triggered payouts. It is Stellar-native and does not depend on the Drips API (see PRD NG6).

## Before you start

Expand Down Expand Up @@ -32,7 +32,13 @@ cargo test --workspace

- 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]`.
- Use issue prefixes that match the area of change:
- `[gateway]` – GitHub webhook ingestion and chain attestation
- `[api]` – REST API for programs and payouts
- `[contracts]` – Soroban escrow contract
- `[backend]` – shared crates, database, or infrastructure
- `[documentation]` – docs, README, or CONTRIBUTING updates
- `[infra]` – Docker, CI/CD, or deployment configuration
- Label Drips Wave issues with `Drips Wave` and `complexity:*`.

## Security
Expand Down
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,10 @@ Run API:
cargo run -p waveflow-api
```

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for branch conventions, issue label prefixes, and the Wave bounty workflow.

## Documentation

- [Product Requirements](docs/PRD.md)
Expand Down