UTDNebula/utd-trends

[Internal]: Add Documentation for every component

Aperta

#182 aperta il 31 ago 2024

Vedi su GitHubGuida contributor
 (4 commenti) (0 reazioni) (0 assegnatari)TypeScript (35 fork)auto 404
Good First IssueStatus: On HoldType: DocumentationType: Internal

Metriche repository

Star
 (28 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Esamina il README esistente di Carousel come modello, quindi esegui npm run docs per visualizzare in anteprima le modifiche. Aggiungi file README e commenti in linea ai componenti Icon elencati nei sotto problemi.
Tech stack
typescriptreact
Dominio
frontend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Gitnpm
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80