Skip to content

[codex] Clarify contributing workflow #53

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
MRhuang1106 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[codex] Clarify contributing workflow #53

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
19 changes: 17 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ WaveFlow automates bounty escrow on Stellar/Soroban with GitHub merge-triggered
1. Read [docs/PRD.md](docs/PRD.md) for product scope.
2. Read [docs/ROADMAP.md](docs/ROADMAP.md) for phase plan.
3. Walk through [docs/core-loop.md](docs/core-loop.md) for the merge-to-payout path.
4. Review [AGENTS.md](AGENTS.md) for repository-specific implementation commands and guardrails.

WaveFlow is a Stellar-native implementation of Wave-style bounty mechanics. Per PRD NG6, it does not depend on or replace Drips APIs; it maps GitHub merge events to WaveFlow gateway attestations and Soroban escrow payouts.

## Development setup

Expand All @@ -32,8 +35,20 @@ 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]`.
- Label Drips Wave issues with `Drips Wave` and `complexity:*`.
- Use issue prefixes to keep scope clear:

| Prefix | Area |
|--------|------|
| `[contracts]` | Soroban escrow logic in `contracts/waveflow-escrow` |
| `[gateway]` | GitHub webhook ingestion and chain attestation in `crates/gateway` |
| `[api]` | REST API, admin routes, and read paths in `crates/api` |
| `[shared]` | Cross-crate types, config, and error handling in `crates/shared` |
| `[documentation]` | README, runbooks, and files under `docs/` |
| `[infra]` | Docker, Render, CI, migrations, and deployment support |

## Wave bounty labels

Label Wave-aligned issues with `Drips Wave` and a `complexity:*` tier. The current gateway points model is fixed at `1 point per merged PR` (see PRD OQ1 and `docs/gateway/payout-calculation.md`), so labels are used for maintainer planning and future point mapping rather than changing payout math today.

## Security

Expand Down
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ cargo run -p waveflow-api

## Documentation

- [Contributing guide](CONTRIBUTING.md)
- [Product Requirements](docs/PRD.md)
- [Implementation Roadmap](docs/ROADMAP.md)
- [Core loop walkthrough](docs/core-loop.md)
Expand Down