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

Define a documented convention for pairing short and long option names in specs

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

@warp-factories đang làm issue này rồi.

Từ ngày 28/8/2026.

  • #376 của @warp-factories — đang mở

Đá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
62/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
rust
Lĩnh vực
cli, documentation

Hướng nghiên cứu

Start by locating the existing option specs and contributor documentation in the repository, then read how short and long names and exclusiveOn lists are currently represented. Document when equivalent names should be paired or separate, how paired options are referenced, and the contributor-facing location; done means the convention is written clearly where contributors will find it.

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

Mô tả

documentation ready-to-implement repro:high triaged

Specs are inconsistent about whether equivalent short/long options are modeled as separate entries or as a paired name array (e.g. ["-d", "--max-depth"]). Contributors adding long forms don't have a documented convention to follow, which shows up in review churn. Requesting a written spec that defines the pairing convention (when to pair vs separate entries, how exclusiveOn lists should reference paired options) and where it should be documented for contributors.

Ngôn ngữ chính
Rust
Star
6
Fork
12
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

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 warpdotdev/command-signatures

Tất cả issue của warpdotdev/command-signatures

Issue tương tự

Thêm issue về Rust

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.