styleguidist/react-styleguidist

Status icons in component list

Open

#1.018 geöffnet am 15. Juni 2018

Auf GitHub ansehen
 (2 Kommentare) (2 Reaktionen) (0 zugewiesene Personen)TypeScript (1.416 Forks)github user discovery
help wanted

Repository-Metriken

Stars
 (11.091 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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.

Contributor Guide

Research-Richtung
Implementieren Sie die Anzeige von Statussymbolen in ComponentsListRenderer durch Parsen von Docblock Tags (@new, @deprecated, @experimental) und zeigen Sie Tooltips mit Tag Beschreibungen an.
Tech Stack
typescriptreact
Domain
frontenddocumentation
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
ReactTypeScriptGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75