ipfs/kubo

Rename "ipfs swarm peers" to "ipfs swarm conns"

Open

#4.196 geöffnet am 1. Sept. 2017

Auf GitHub ansehen
 (4 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Go (2.725 Forks)batch import
help wantedkind/enhancement

Repository-Metriken

Stars
 (13.906 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 4T 2h) (28 gemergte PRs in 30 T)

Beschreibung

Type:

Enhancement(ish)

Severity:

Pedantic

Description:

ipfs swarm peers is misnamed, it should be ipfs swarm conns (it prints connections). We should:

  1. Introduce the new command.
  2. Deprecate the old one and hide it (but don't actually remove it).

Supersedes #4104 (would break too much)

Contributor Guide

Research-Richtung
Das Issue erfordert das Hinzufügen eines neuen Befehls 'ipfs swarm conns', der den bestehenden Befehl 'ipfs swarm peers' als Alias verwendet, und anschließend die Veraltung und Ausblendung des alten Befehls. Das Repository verwendet Go und die CLI ist mit cobra aufgebaut. Schauen Sie sich die bestehende Implementierung von 'ipfs swarm peers' (wahrscheinlich in core/commands/swarm.go) an, um die Struktur zu verstehen. Der neue Befehl sollte denselben Handler aufrufen. Folgen Sie dem Veraltungsmuster, das an anderer Stelle im Codebase verwendet wird, z. B. indem Sie den alten Befehl als versteckt markieren und eine Veraltungsmeldung hinzufügen. Keine verlinkten PRs oder Kommentare deuten auf vorherige Arbeiten hin, daher handelt es sich um Neuland.
Tech Stack
go
Domain
backendcli
Issue Type
Refactoring
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GoGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90