[FEATURE] improve CLI command name and parameters with consistent naming
- Ngôn ngữ chính
- Go
- Star
- 28
- Fork
- 23
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
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
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
Hướng nghiên cứu
Issue này nói về việc đổi tên lệnh CLI và tham số để đảm bảo tính nhất quán. Bắt đầu bằng cách kiểm tra các định nghĩa lệnh hiện có trong codebase, có thể trong các tệp như cmd/ hoặc main.go. Hiểu các mẫu đặt tên hiện tại và các quy tắc được đề xuất từ liên kết Slack. Kiểm tra xem có bài kiểm tra nào cần cập nhật không. 'Done' có nghĩa là tất cả các lệnh và tham số của chúng tuân theo một quy ước đặt tên duy nhất và nhất quán.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- cli, go, shell
- Lĩnh vực
- cli, developer-experience
- Loại issue
- Tái cấu trúc
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 45/100