Book: Section on config-description
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức phù hợp với người mới
- 20/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Cần làm rõ
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- rust
- Lĩnh vực
- cli, documentation
Hướng nghiên cứu
Bắt đầu bằng việc đọc cuộc thảo luận trong pull request #166, đặc biệt là bình luận được tham chiếu, và xem xét cách sử dụng crate type_description được đề xuất. Issue mô tả một khái niệm rộng về mô tả cấu hình mà máy có thể đọc được, thay vì nêu tên các tệp hoặc bài kiểm thử. Để có một kết quả rõ ràng, cần thống nhất về phạm vi và cách tiếp cận trước khi có thể bắt đầu triển khai.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
As requested in https://github.com/rust-cli/book/pull/166#discussion_r972045274 I'd like to open up a discussion about config description.
The general idea of what I call "config description" here is that a given configuration type can describe itself in a machine-readable way, which can ultimatively be rendered to user-documentation.
A user would ask the program "tell me how I can configure you?" and the program is then able to tell the user "I get configured via the following settings: 'greeting_message', which has to be a String, 'repeat', which has to be a number greater than zero".
A possible solution for this is sketched out in #166 using the type_description crate.
- Ngôn ngữ chính
- Rust
- Star
- 1.1k
- Fork
- 122
- 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
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của rust-cli/book
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 68/100
-
Broken Discord linkĐang mở
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 35/100
-
documentation
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 45/100
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 35/100
-
bug
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 25/100
Tất cả issue của rust-cli/book
Issue tương tự
-
Add MimirĐang mở
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 78/100
slavakurilyak/awesome-ai-agents#759 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 62/100
compiler-explorer/compiler-explorer#9272 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Trash, bin or rubbish?Đang mở
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 63/100
pop-os/cosmic-files#2117 ·
Maintainer thường phản hồi trong vòng 2 ngày
-
L: java:gradle L: java:maven L: ruby:bundler T: bug 🐞
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
dependabot/dependabot-core#16547 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
bug status:ready-for-test
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
UniClipboard/UniClipboard#1985 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày