0chain / 0chain/zboxcli

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

オープン
#113 コメント 0 件 リアクション 0 件 担当者 1 名 @K-Kumar-01 が担当を希望しています GitHub で見る
enhancement post-mainnet
主要言語
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

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。