styleguidist/react-styleguidist

Moved component locations should be marked as breaking changes

Open

#1.268 geöffnet am 7. Feb. 2019

Auf GitHub ansehen
 (6 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (1.416 Forks)github user discovery
documentationgood first issuehelp wanted

Repository-Metriken

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

Beschreibung

When upgrading to the beta I got this error:

./docs_helpers/DocsWrapper.js
Module not found: Can't resolve 'react-styleguidist/lib/rsg-components/StyleGuide/StyleGuideRenderer'

When I change the path to react-styleguidist/lib/client/rgs-components... it compiled.

Since these module locations have been treated as public API (for overrides), their change in location should be documented as a breaking change.

Contributor Guide

Research-Richtung
Identifizieren Sie die verschobenen Komponentenpositionen im Codebase und aktualisieren Sie das Changelog oder die Migrationsanleitung, um sie als Breaking Changes zu markieren.
Tech Stack
typescriptreact
Domain
frontend
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
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
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70