styleguidist/react-styleguidist

Moved component locations should be marked as breaking changes

Open

#1 268 ouverte le 7 févr. 2019

Voir sur GitHub
 (6 commentaires) (0 réactions) (0 assignés)TypeScript (1 416 forks)github user discovery
documentationgood first issuehelp wanted

Métriques du dépôt

Stars
 (11 091 stars)
Métriques de merge PR
 (Métriques PR en attente)

Description

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.

Guide contributeur

Direction de recherche
Identifiez les emplacements des composants déplacés dans la base de code et mettez à jour le journal des modifications ou le guide de migration pour les marquer comme des modifications cassantes.
Stack technique
typescriptreact
Domaine
frontend
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70