UTDNebula/utd-trends

[Internal]: Add Documentation for every component

Offen

#182 geöffnet am 31.08.2024

Auf GitHub ansehenContributor Guide
 (4 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (35 Forks)auto 404
Good First IssueStatus: On HoldType: DocumentationType: Internal

Repository-Metriken

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

Beschreibung

Overview

Ensure every component's README has accurate documentation about what the component is and how it is used For the README's, basic requirements are: (a) where the component is used in the UI, (b) what data is being passed in, (c) what the component is doing (the javascript mainly)

Also include in-line comments to explain how functions work

Look at src\components\navigation\Carousel\README.md as a reference and see results by running npm run docs and going to http://localhost:6060 in your browser.

Sub-issues:

  • Add documentation to the React StyleGuide for Icon Components

Contributor Guide

Research-Richtung
Prüfe das vorhandene Carousel README als Vorlage und führe dann npm run docs aus, um deine Änderungen in der Vorschau zu sehen. Füge README Dateien und Inline Kommentare zu den in den Unteraufgaben aufgeführten Icon Komponenten hinzu.
Tech Stack
typescriptreact
Domain
frontend
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
Gitnpm
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80