Redocly/redocly-cli

Make completion feature easier to find

Aberta

#1.160 aberto em 7 de jul. de 2023

Ver no GitHubGuia do colaborador
 (0 comentário) (0 reação) (0 responsável)TypeScript (222 forks)auto 404
Type: Enhancementgood first issuep3

Métricas do repositório

Stars
 (1.481 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

Is your feature request related to a problem? Please describe.

We have the redocly completion command to let users add autocomplete to their commands, but it's not well-known so some users don't find it. Let's make it easier for users to discover this existing feature.

Describe the solution you'd like

Add a message after installation telling the user about the command if they want autocomplete.

Describe alternatives you've considered

We talked about automatically installing the autocomplete but that's more difficult and not every user will want that. The existing behaviour is fine, but the purpose of the issue is to make it more findable.

Guia do colaborador

Direção de pesquisa
Localize o script pós instalação no repositório e adicione uma mensagem console.log informando os usuários sobre o comando 'redocly completion' para funcionalidade de autocomplete.
Pilha de tecnologia
typescript
Domain
cli
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
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.
80