styleguidist/react-styleguidist

Status icons in component list

Open

#1.018 aberto em 15 de jun. de 2018

Ver no GitHub
 (2 comments) (2 reactions) (0 assignees)TypeScript (1.416 forks)github user discovery
help wanted

Métricas do repositório

Stars
 (11.091 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

The problem

No idea which items in the component list are new, deprecated, or under development/experimental. A good example would be GitHub's guide: https://styleguide.github.com/primer/

Proposed solution

Update ComponentsListRenderer to display the status based on docblock tags, like @new, @deprecated, and @experimental. Tag descriptions would be shown in a tooltip.

Alternative solutions

N/A

Additional context

I'm testing this currently by overriding SG components. Will report back.

Guia do colaborador

Direção de pesquisa
Implemente a exibição de ícones de status no ComponentsListRenderer analisando as tags docblock (@new, @deprecated, @experimental) e mostrando dicas de ferramentas com descrições das tags.
Pilha de tecnologia
typescriptreact
Domain
frontenddocumentation
Tipo Issue
Funcionalidade
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.
Meio dia
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
ReactTypeScriptGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75