Overview
The streamforge-stellar-rewards repository lacks clear documentation explaining how the reward flow works end-to-end. Contributors and maintainers need to understand how USDC rewards move from escrow to a contributor's Stellar wallet before they can safely work on this codebase.
What needs to be done
Update the existing README.md to include the following sections:
- Overview — what this repo does in plain language
- How the reward flow works — step by step explanation of:
- How escrow is created and funded
- What conditions trigger a release
- How USDC is sent to the contributor's Stellar wallet
- What happens when a release fails
- Setup instructions — how to install dependencies and run the project locally
- Environment variables — list all required
.env variables with descriptions
- Running tests — how to run the test suite
- Contributing — link to or include basic contribution guidelines
Acceptance Criteria
Notes
Write for a developer who has never seen this codebase before. Avoid jargon where possible. A simple diagram of the reward flow is a bonus but not required.
Overview
The
streamforge-stellar-rewardsrepository lacks clear documentation explaining how the reward flow works end-to-end. Contributors and maintainers need to understand how USDC rewards move from escrow to a contributor's Stellar wallet before they can safely work on this codebase.What needs to be done
Update the existing
README.mdto include the following sections:.envvariables with descriptionsAcceptance Criteria
README.mdNotes
Write for a developer who has never seen this codebase before. Avoid jargon where possible. A simple diagram of the reward flow is a bonus but not required.