yugabyte/yugabyte-db

[usability] Allow prefix matching for yb-admin commands

Open

#9.624 geöffnet am 6. Aug. 2021

Auf GitHub ansehen
 (4 Kommentare) (0 Reaktionen) (1 zugewiesene Person)C (1.003 Forks)batch import
area/docdbgood first issuehelp wantedkind/enhancementpriority/medium

Repository-Metriken

Stars
 (8.229 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 17T 21h) (92 gemergte PRs in 30 T)

Beschreibung

Jira Link: DB-2024 Currently when yb-admin command is slightly misspelled, e.g. list_snapshot_schedule instead of list_snapshot_schedules, the user would be given the whole list of commands.

User experience can be improved by using the (partial) command as prefix.

If there is only one match, that match would be picked - we can ask the user to confirm the selection (or add option, say -accept-prefix-match which would accept the selection without asking). In case there are multiple candidates for the given prefix, the list of commands would be printed.

Contributor Guide

Research-Richtung
Untersuche die Logik zum Parsen von yb admin Befehlen. Identifiziere, wo Befehle abgeglichen werden, und implementiere die Präfixübereinstimmung: Wenn ein teilweiser Befehl eindeutig mit einem vollständigen Befehl übereinstimmt, biete an, ihn auszuführen (mit Bestätigungsoption). Bei mehreren Übereinstimmungen liste sie auf. Suche nach der vorhandenen Befehlsregistrierungsstruktur.
Tech Stack
cgo
Domain
cli
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
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
Gitcommand line basics
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60