styleguidist/react-styleguidist

Moved component locations should be marked as breaking changes

Open

#1.268 aberto em 7 de fev. de 2019

Ver no GitHub
 (6 comments) (0 reactions) (0 assignees)TypeScript (1.416 forks)github user discovery
documentationgood first issuehelp wanted

Métricas do repositório

Stars
 (11.091 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

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.

Guia do colaborador

Direção de pesquisa
Identifique os locais dos componentes movidos no codebase e atualize o changelog ou guia de migração para marcá los como alterações de quebra.
Pilha de tecnologia
typescriptreact
Domain
frontend
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70