UTDNebula/utd-trends

[Internal]: Add documentation to the React StyleGuide for Planner Components

Offen

#491 geöffnet am 03.09.2025

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (1 zugewiesene Person)TypeScript (35 Forks)auto 404
Good First IssueStatus: On HoldType: Documentation

Repository-Metriken

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

Beschreibung

Add documentation to the page for the components in our React StyleGuideIst. For a reference, see the documentation for the (Carousel component)[http://localhost:6060/#/Navigation%20Components?id=carousel]. See https://github.com/UTDNebula/utd-trends/issues/182#issue-2498557609 for more info about the styleguide.

Planner Components: PlannerCard PlannerCoursesTable PlannerSection PlannerSchedule PlannerEmpty

These components are not yet in the style guide, so you will have to edit styleguide.config.js as well

Contributor Guide

Research-Richtung
Untersuche die vorhandene styleguide.config.js und füge für jede Planner Komponente Einträge nach dem Vorbild von Carousel hinzu. Schreibe dann die Dokumentation für jede Komponente in eine .md Datei.
Tech Stack
typescriptreact
Domain
frontenddocumentation
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.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitReact
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85