UTDNebula/utd-trends

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

Aberta

#489 aberto em 3 de set. de 2025

Ver no GitHubGuia do colaborador
 (3 comentários) (0 reação) (1 responsável)TypeScript (35 forks)auto 404
Good First IssueStatus: On HoldType: Documentation

Métricas do repositório

Stars
 (28 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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

Guia do colaborador

Direção de pesquisa
Analise a documentação do componente Carousel (http://localhost:6060/#/Navigation%20Components?id=carousel) como modelo. Em seguida, escreva a documentação para cada componente listado (Github Button, SingleGradesInfo, SingleProfInfo, Split, StickySide, WhatsNew) seguindo o mesmo estilo e estrutura.
Pilha de tecnologia
react
Domain
frontenddocumentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85