styleguidist/react-styleguidist

Status icons in component list

Open

#1018 aperta il 15 giu 2018

Vedi su GitHub
 (2 commenti) (2 reazioni) (0 assegnatari)TypeScript (1416 fork)github user discovery
help wanted

Metriche repository

Star
 (11.091 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Implementa la visualizzazione delle icone di stato in ComponentsListRenderer analizzando i tag docblock (@new, @deprecated, @experimental) e mostrando tooltip con le descrizioni dei tag.
Tech stack
typescriptreact
Dominio
frontenddocumentation
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
ReactTypeScriptGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75