[FEATURE] improve CLI command name and parameters with consistent naming
- 主要语言
- Go
- 星标
- 28
- 派生
- 23
- PR 合并指标
- 30 天内没有已合并 PR
描述
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
贡献指南
这个仓库没有索引到贡献指南
调研方向
该 issue 是关于重命名 CLI 命令和参数以确保一致性。首先检查代码库中现有的命令定义,可能位于 cmd/ 或 main.go 等文件中。理解当前的命名模式以及 Slack 链接中提出的规则。检查是否有需要更新的测试。“Done” 意味着所有命令及其参数都遵循单一、一致的命名约定。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- cli, go, shell
- 领域
- cli, developer-experience
- Issue 类型
- 重构
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 45/100