UTDNebula/utd-trends

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

Ouverte

#489 ouverte le 3 sept. 2025

Voir sur GitHubGuide contributeur
 (3 commentaires) (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. 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

Guide contributeur

Direction de recherche
Consultez la documentation du composant Carousel (http://localhost:6060/#/Navigation%20Components?id=carousel) comme modèle. Ensuite, rédigez la documentation pour chaque composant listé (Github Button, SingleGradesInfo, SingleProfInfo, Split, StickySide, WhatsNew) en suivant le même style et la même structure.
Stack technique
react
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.
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
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85