UTDNebula/utd-trends

[Internal]: Add Documentation for every component

Ouverte

#182 ouverte le 31 août 2024

Voir sur GitHubGuide contributeur
 (4 commentaires) (0 réaction) (0 personne assignée)TypeScript (35 forks)auto 404
Good First IssueStatus: On HoldType: DocumentationType: Internal

Métriques du dépôt

Stars
 (28 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

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

Guide contributeur

Direction de recherche
Examinez le README existant du Carousel comme modèle, puis exécutez npm run docs pour prévisualiser vos modifications. Ajoutez des fichiers README et des commentaires en ligne aux composants d'icônes répertoriés dans les sous problèmes.
Stack technique
typescriptreact
Domaine
frontend
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Gitnpm
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80