Proto-UI/Proto-UI

Write the first-prototype contributor guide

Geschlossen

#235 geöffnet am 04.05.2026

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (12 Forks)auto 404
F5 - Largedocsgood first issuehelp wantedv0 launch

Repository-Metriken

Stars
 (29 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Campaign: v0-good-first-issues Seed id: first-prototype-guide

Summary

Write a practical guide that helps a new contributor add their first Proto UI prototype.

Scope

  • Start from the existing prototype docs and contributor docs.
  • Use a small existing prototype as the walkthrough example.
  • Include local commands for build, docs preview, and checks.

Acceptance criteria

  • The guide has a clear step-by-step path from package location to demo.
  • The guide includes a checklist before opening a PR.
  • The guide links to relevant contracts instead of duplicating them.

References

  • apps/www/src/content/docs/en/build/prototypes
  • apps/www/src/content/docs/en/build/contribute.md
  • packages/prototypes/base/README.md

Out of scope

  • A full API reference rewrite.
  • Adapter implementation details.

Maintainer notes

Category: docs Difficulty: small

Contributor Guide

Research-Richtung
Lies die bestehenden Prototyp Dokumente in `apps/www/src/content/docs/en/build/prototypes` und den Beitragsleitfaden in `apps/www/src/content/docs/en/build/contribute.md`. Verwende einen kleinen Prototyp aus `packages/prototypes/base/README.md` als Walkthrough Beispiel. Füge lokale Befehle zum Bauen, zur Vorschau der Dokumentation und zum Ausführen von Prüfungen hinzu. Stelle einen schrittweisen Pfad vom Paketstandort zur Demo, eine Checkliste vor dem Öffnen eines PRs und Links zu relevanten Verträgen sicher.
Tech Stack
typescriptreact
Domain
documentationfrontend
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitNode.js
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90