0chain / 0chain/zboxcli

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

Abierto
#113 0 comentarios 0 reacciones 1 asignado Reclamado por @K-Kumar-01 Ver en GitHub
enhancement post-mainnet
Lenguaje dominante
Go
Estrellas
28
Forks
23
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

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

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Línea de trabajo

El issue trata sobre renombrar comandos y parámetros de CLI para lograr consistencia. Comience examinando las definiciones de comandos existentes en la base de código, probablemente en archivos como cmd/ o main.go. Comprenda los patrones de nomenclatura actuales y las reglas propuestas en el enlace de Slack. Verifique si hay pruebas que puedan necesitar actualización. 'Done' significa que todos los comandos y sus parámetros siguen una única convención de nomenclatura consistente.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
cli, go, shell
Área
cli, developer-experience
Tipo de issue
Refactorización
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.