UTDNebula/utd-trends

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

Ouverte

#491 ouverte le 3 sept. 2025

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (1 personne assignée)TypeScript (35 forks)auto 404
Good First IssueStatus: On HoldType: Documentation

Métriques du dépôt

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

Description

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

Guide contributeur

Direction de recherche
Examinez le fichier styleguide.config.js existant et ajoutez des entrées pour chaque composant Planner en suivant l'exemple de Carousel. Ensuite, rédigez la documentation pour chaque composant dans un fichier .md.
Stack technique
typescriptreact
Domaine
frontenddocumentation
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.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
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
GitReact
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85