Skip to content

chore(community): setup Community Standards and enrich README with Studio visual screenshots - #13

Merged
namanmukund merged 3 commits into
mainfrom
chore/setup-community-standards
Sep 19, 2026
Merged

namanmukund merged 3 commits into
mainfrom
chore/setup-community-standards

Conversation

@namanmukund

Copy link
Copy Markdown
Owner

Summary

This PR establishes full compliance with GitHub Community Standards (bringing the repository health score to 100%) and enriches the README & documentation with high-resolution visual showcases of AutoGraphQL Studio.


🛡️ Community Standards Checklist (100% Health Score)

Item File Description
Code of Conduct CODE_OF_CONDUCT.md Standard Contributor Covenant v2.1 pledge, behavioral expectations, and enforcement guidelines with contact namanmukund@gmail.com.
Contributing Guidelines CONTRIBUTING.md Comprehensive contributor onboarding guide covering Node.js 18+ prerequisites, local environment setup, running tests (npm test), Conventional Commit standards, and PR workflows.
Security Policy SECURITY.md & .github/SECURITY.md Supported versions table, confidential reporting instructions (GitHub Private Vulnerability Reporting + email), SLA response timeline (48h acknowledgment), and architectural security overview (RLS, depth limiting, HMAC webhook signing).
Issue Forms & Templates .github/ISSUE_TEMPLATE/ Modern interactive YAML issue forms + markdown fallback:
• bug_report.yml & bug_report.md: Structured form for reproduction steps, dialect selector, logs, and environment details.
• feature_request.yml & feature_request.md: Structured form for motivation, proposed SDL directives, and component tags.
• config.yml: Helpful community links pointing to GitHub Discussions and documentation.

🎨 Documentation & Studio Showcase

  • 9 High-Resolution Desktop Screenshots added to docs/assets/studio/:
    • 01-studio-data-browser.png: Universal Data Browser & Content Manager (Hero Showcase)
    • 02-studio-schema-studio.png: Schema Studio & Live AST Modeler
    • 03-studio-visual-erd.png: Interactive Visual Entity-Relationship Canvas
    • 04-studio-access-rbac.png: Access Control & Role-Based Permissions Matrix
    • 05-studio-webhooks-outbox.png: Birdwatch Transactional Outbox & Webhooks
    • 06-studio-telemetry-metrics.png: Real-Time Telemetry & Winston Log Console
    • 07-studio-lifecycle-hooks.png: Lifecycle Hooks Studio
    • 08-studio-databases-rls.png: Multi-Database Diagnostics & RLS Inspector
    • 09-competitor-analysis-slides.png: Competitor Analysis Presentation Slide
  • README Optimization:
    • Added hero showcase banner under video walkthrough.
    • Replaced plain text table with 6 visual feature cards detailing key developer workflows.
  • Studio User Guide (docs/studio-user-guide.md):
    • Embedded screenshots into tutorial sections for seamless visual onboarding.
  • Deep Linking in Studio (src/studio/public/index.html):
    • Added URL query param (?tab=tab-erd, ?tab=tab-schema) and hash routing support.

🧪 Verification

  • Automated test suite: npm test — 91 / 91 passed ✅ across all suites.

@namanmukund
namanmukund merged commit 1f30f51 into main Sep 19, 2026
3 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.

1 participant