Redocly/redocly-cli

Make completion feature easier to find

Aperta

#1160 aperta il 7 lug 2023

Vedi su GitHubGuida contributor
 (0 commenti) (0 reazioni) (0 assegnatari)TypeScript (222 fork)auto 404
Type: Enhancementgood first issuep3

Metriche repository

Star
 (1481 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Trova lo script post installazione nel repository e aggiungi un messaggio console.log che informa gli utenti sul comando 'redocly completion' per la funzionalità di completamento automatico.
Tech stack
typescript
Dominio
cli
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80