0chain / 0chain/zboxcli

[FEATURE] improve CLI command name and parameters with consistent naming

Ouverte
#113 0 commentaires 0 réactions 1 personne assignée Réclamée par @K-Kumar-01 Voir sur GitHub
enhancement post-mainnet
Langage dominant
Go
Étoiles
28
Forks
23
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

for now, there are some naming rules on cli command name
- lower-case: ` list-all`, `add-collab`
- lowercase: `listallocations`, `addcurator`,`encryptionpublickey`
- prefix: `alloc-cancel`,`alloc-fini`
- without prefix: `get`
- fullname: `list-all`
- shortname: `ls-blobbers`

And there are some naming rules on cli command parameters
- lower-case : `rx_pay`,`free_storage`,`read_price`, `write_price`
- lowercase: `remotepath`
- fullname: `allocation`
- shorname: `collabid`,`mcct`

It is better to rename all of them with consistent naming rule.

eg `lower-case with prefix and short name`, only root file system commands should be named without prefix.

for examples:
- `mkdir`, `copy`, `upload`, `download`,`delete`...etc
- `alloc-new`, `alloc-get`, `alloc-update`

see detail on https://0chain.slack.com/archives/C01U94VF56Y/p1632609085125300

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Piste de recherche

Le problème concerne le renommage des commandes CLI et des paramètres pour assurer la cohérence. Commencez par examiner les définitions de commandes existantes dans la base de code, probablement dans des fichiers comme cmd/ ou main.go. Comprenez les modèles de dénomination actuels et les règles proposées dans le lien Slack. Vérifiez si des tests doivent être mis à jour. 'Done' signifie que toutes les commandes et leurs paramètres suivent une seule convention de dénomination cohérente.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
cli, go, shell
Domaine
cli, developer-experience
Type d'issue
Refactorisation
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.