UTDNebula/utd-trends

[Internal]: Add documentation to the React StyleGuide for Common components

Offen

#489 geöffnet am 03.09.2025

Auf GitHub ansehenContributor Guide
 (3 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. See https://github.com/UTDNebula/utd-trends/issues/182#issue-2498557609 for more info about the styleguide.

Components in this sub-issue: Github Button SingleGradesInfo SingleProfInfo Split StickySide WhatsNew

Contributor Guide

Research-Richtung
Überprüfen Sie die Dokumentation der Carousel Komponente (http://localhost:6060/#/Navigation%20Components?id=carousel) als Vorlage. Schreiben Sie dann für jede aufgeführte Komponente (Github Button, SingleGradesInfo, SingleProfInfo, Split, StickySide, WhatsNew) Dokumentation im gleichen Stil und Aufbau.
Tech Stack
react
Domain
frontenddocumentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
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.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85