UTDNebula/utd-trends

[Internal]: Add Documentation for every component

Aberta

#182 aberto em 31 de ago. de 2024

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

Métricas do repositório

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

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

Guia do colaborador

Direção de pesquisa
Examine o README existente do Carousel como modelo e execute npm run docs para visualizar suas alterações. Adicione arquivos README e comentários inline aos componentes de ícone listados nas subtarefas.
Pilha de tecnologia
typescriptreact
Domain
frontend
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
Gitnpm
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80