Skip to content

Docs: publish API contract index.#656

Merged
Otaiki1 merged 2 commits into
crackedstudio:masterfrom
TheShnider:feature/stellar-wave-standards
May 31, 2026
Merged

Docs: publish API contract index.#656
Otaiki1 merged 2 commits into
crackedstudio:masterfrom
TheShnider:feature/stellar-wave-standards

Conversation

@TheShnider
Copy link
Copy Markdown
Contributor

Closes #624

Define comprehensive quality standards for Stellar Wave issues:
- STELLAR_WAVE_CHECKLIST.md: Complete requirement checklist covering docs, tests, telemetry, error handling, migrations, and package-specific expectations
- CONTRIBUTOR_GUIDE.md: Step-by-step guidance for implementing Stellar Wave issues
- QUICK_REFERENCE.md: One-page checklist and CI commands
- README.md: Navigation guide for quality standards

These standards ensure every Stellar Wave issue meets a high bar for:
- Documentation (API specs, code comments, runbooks)
- Tests (unit, integration, e2e with 80%+ coverage)
- Logging & observability (structured logs, trace IDs, error reporting)
- Error handling (user-friendly messages, graceful degradation)
- Database safety (TypeORM migrations, rollback testing)
- Security (no secrets, dependency audits)

Includes package-specific expectations and CI commands for backend, client, indexer, oracle, and sdk.

Fixes: Stellar Wave issue - Define quality standards
@vercel
Copy link
Copy Markdown

vercel Bot commented May 29, 2026

@TheShnider is attempting to deploy a commit to the otaiki1's projects Team on Vercel.

A member of the Team first needs to authorize it.

@Otaiki1 Otaiki1 merged commit e8309bb into crackedstudio:master May 31, 2026
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: publish API contract index

2 participants