-
Notifications
You must be signed in to change notification settings - Fork 9
Open
Labels
Stellar WaveIssues in the Stellar wave programIssues in the Stellar wave programbackenddocumentationImprovements or additions to documentationImprovements or additions to documentation
Description
Description
Add docs/ARCHITECTURE.md describing HTTP API, workers, DB, Redis, RPC clients, and data flow for settlements.
Requirements and context
- Mermaid diagram encouraged.
- Align with actual code layout.
Suggested execution
- Fork the repository and create a branch (example below).
- Implement changes in StreamPay-Backend (TypeScript / Express per
package.json). - Keep the service secure, tested, and documented; prefer small, reviewable PRs.
git checkout -b docs/backend-architectureImplementation targets
StreamPay-Backend/docs/ARCHITECTURE.md.
Tests and validation
-
Peer review from team.
-
Run
npm testandnpm run lintinStreamPay-Backend. -
Cover edge cases; include test output and brief security notes in the PR description.
Guidelines
- Target minimum 95% test coverage on new or changed backend code (or justify gaps).
- Clear documentation (OpenAPI / README / inline docs as specified).
- Timeframe: 96 hours from assignment.
Example commit message
docs(backend): architecture overview with diagram
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
Stellar WaveIssues in the Stellar wave programIssues in the Stellar wave programbackenddocumentationImprovements or additions to documentationImprovements or additions to documentation