Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Add better docs for new options system

Đang mở
#247 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
45/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
ruby
Lĩnh vực
cli, documentation

Hướng nghiên cứu

Bắt đầu với lib/cli/kit/opts.rb để hiểu option, multi_option, position, rest, skippable positions và callable defaults. Đọc pull request #246 về mẫu --no-<multi_option>. Công việc được xem là hoàn tất khi hệ thống tùy chọn mới và các mẫu hữu ích được ghi lại, bao gồm các hành vi được liệt kê.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

enhancement

We don't have much in the way of docs covering the new option system. There are many things in https://github.com/Shopify/cli-kit/blob/main/lib/cli/kit/opts.rb that should probably be covered, e.g.

  • option
  • multi_option
  • position
  • rest
  • skippable positions
  • callable defaults
  • ...

Additionally, it would be good to include useful patterns such the --no-<multi_option> flag to zero a multi_option default described in https://github.com/Shopify/cli-kit/pull/246

Ngôn ngữ chính
Ruby
Star
161
Fork
16
Merge trung bình
3 giờ 21 phút
Pull request đã merge (30 ngày)
5

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

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của Shopify/cli-kit

Tất cả issue của Shopify/cli-kit

Issue tương tự

Thêm issue về Ruby

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.