Skip to content

feat: add Wave documentation, triage tooling, and release checklists …#881

Merged
edehvictor merged 2 commits into
edehvictor:mainfrom
Maximum-Prosper:docs/wave-improvements
Jun 27, 2026
Merged

feat: add Wave documentation, triage tooling, and release checklists …#881
edehvictor merged 2 commits into
edehvictor:mainfrom
Maximum-Prosper:docs/wave-improvements

Conversation

@Maximum-Prosper

@Maximum-Prosper Maximum-Prosper commented Jun 27, 2026

Copy link
Copy Markdown
Contributor

Description

Resolves multiple Wave documentation and tooling enhancements to improve contributor experience, maintainer workflows, and release readiness.
Closes #21

Changes Summary

Issue #435: Fix API base URL fallback behavior in preview environments

  • Added isApiConfigured() function to safely check API configuration status
  • Added getApiBaseUrlOrNull() for graceful error handling
  • Expanded test coverage from 6 to 15+ test cases covering all environment scenarios
  • Updated docs/frontend-env-reference.md with comprehensive Preview environment setup section including:
    • Step-by-step Vercel configuration guide
    • Common preview configurations table (staging, local tunnel, VPC)
    • Environment variable reference table
    • Troubleshooting guidance for CORS and deployment issues
  • Updated .env.example with clarified comments about preview requirements

Files: client/src/lib/api.ts, client/src/lib/api.test.ts, docs/frontend-env-reference.md, client/.env.example

Issue #448: Create maintainer dashboard issue triage view

  • Implemented scripts/issue-triage.js with automated GitHub API integration:
    • Fetches real-time issue counts by triage state
    • Displays unclaimed/claimed Wave issues, PRs pending, blocked issues, needs-info counts
    • Includes setup instructions and error handling
  • Enhanced scripts/maintainer_saved_searches.sh with:
    • Direct bookmark links for all saved searches
    • CLI command examples using GitHub's gh tool
  • Expanded docs/triage-process.md (200+ lines) with:
    • Weekly triage workflow broken into 6 actionable steps (5 min each)
    • Copy-paste ready saved search queries
    • GitHub token setup guide
    • Escalation playbook with response time SLAs
    • Good first issue best practices

Files: scripts/issue-triage.js, scripts/maintainer_saved_searches.sh, docs/triage-process.md

Issue #444: Add UI snapshot checklist for visual contribution reviews

  • Enhanced CONTRIBUTING.md with detailed UI snapshot requirements:
    • Clear table of when screenshots are required vs optional
    • Viewport size requirements (Desktop/Tablet/Mobile)
    • Screenshot capture tool recommendations
    • Guidance on "no visual changes" declarations
  • Added comprehensive UI Snapshots & Visual Review Checklist section to docs/contributor-guide.md:
    • Clear requirements and best practices
    • Accessibility & contrast guidelines (WCAG AA standards)
    • Tools for responsive testing
    • Reviewer expectations
  • Updated .github/pull_request_template.md with:
    • Enhanced UI snapshot checklist with 3 viewport options
    • Clear "no visual changes" option with example
    • Link to detailed contributor guide

Files: CONTRIBUTING.md, docs/contributor-guide.md, .github/pull_request_template.md

Issue #443: Add release readiness checklist for Wave submissions

  • Created comprehensive Stellar Wave Submission Checklist in docs/release-checklist.md:
    • 8 critical sections (Issue linking, CI, Code quality, Design, Docs, Smoke test, Security, Template)
    • Clear checkboxes and verification steps
    • Examples and best practices
  • Created Maintainer Deployment Checklist with:
    • Pre-deployment review phase
    • Vercel production/preview verification (environment variable scoping table)
    • Backend & contract deployment validation
    • Smoke tests with automated workflow instructions
    • Post-deployment checks and rollback procedures
  • Added Deployment Infrastructure Checks reference table
  • Added Automated Release Smoke Report workflow instructions
  • Updated CONTRIBUTING.md to prominently link Wave release readiness guidance

Files: docs/release-checklist.md, CONTRIBUTING.md

Testing & Verification

  • ✅ All new test cases in client/src/lib/api.test.ts pass (15+ scenarios)
  • scripts/issue-triage.js tested with GitHub API (requires GITHUB_TOKEN)
  • ✅ All documentation follows project style and links are validated
  • ✅ PR template changes backward compatible with existing PRs

Related Documentation

All changes reference and align with:

Impact

  • Contributors: Clearer expectations on UI snapshots, release readiness, and code quality
  • Maintainers: Automated triage dashboard, structured weekly workflow, deployment checklists
  • Users: Better preview environment handling, graceful API configuration errors, transparent release process

No visual changes — Documentation and tooling updates only.

@vercel

vercel Bot commented Jun 27, 2026

Copy link
Copy Markdown

@Maximum-Prosper is attempting to deploy a commit to the Edeh Victor's projects Team on Vercel.

A member of the Team first needs to authorize it.

@edehvictor edehvictor left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice implementation!

@edehvictor
edehvictor merged commit 25dee0f into edehvictor:main Jun 27, 2026
6 of 9 checks passed
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.

2 participants