styleguidist/react-styleguidist

Improve single-component usage

Open

#195 geöffnet am 12. Okt. 2016

Auf GitHub ansehen
 (16 Kommentare) (5 Reaktionen) (0 zugewiesene Personen)TypeScript (1.416 Forks)github user discovery
enhancementgood first issuehelp wanted

Repository-Metriken

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

Beschreibung

React Styleguidist could be awesome for documenting components, like this, but now it’s not.

  • New option to disable sidebar.
  • New option, getComponentName(), to change the title. @visibleName JSDoc tag — #933
  • “Fork me” ribbon with customisable URL.
  • New option to hide isolated link (needs discussion).
  • Hide path line if it’s empty.

Anything else? Any feedback?

Contributor Guide

Research-Richtung
Überprüfe die Diskussion in den Issue Kommentaren, um die gewünschten neuen Optionen zu verstehen (z. B. Seitenleiste deaktivieren, isolierten Link ausblenden). Untersuche den styleguidist Quellcode, um zu sehen, wie vorhandene Optionen implementiert sind, und schlage vor, eine neue Konfigurationsoption mit entsprechender Dokumentation hinzuzufügen.
Tech Stack
reactjavascripttypescript
Domain
frontenddeveloper experience
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
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.
Meist klar
Voraussetzungen
ReactJavaScript
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65