Feature request: documentation
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
- 25/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ệ
- ruby
- Lĩnh vực
- documentation
Hướng nghiên cứu
Issue không nêu tên tệp, bài kiểm thử hoặc điểm vào nào. Trước tiên, hãy khảo sát mã Ruby của gem và phần tích hợp với EventMachine để lập bản đồ những nội dung cần giải thích, sau đó xác định phạm vi tài liệu và checklist hoàn thành. Được xem là hoàn tất khi các đường dẫn mã liên quan và các mối quan hệ sử dụng đã được ghi lại đầy đủ để giảm công sức điều hướng được nêu ra.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
This gem desperately lacks documentation of the code. Navigating the code trying to figure out where something is instantiated and used when using it with my own code that's using EventMachine takes a lot of effort. Documenting the code would make this much easier.
I'm creating this feature request to track this effort.
- Ngôn ngữ chính
- Ruby
- Star
- 238
- Fork
- 49
- 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 faye/websocket-driver-ruby
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 35/100
faye/websocket-driver-ruby#96 · 1 bình luận ·
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 25/100
faye/websocket-driver-ruby#89 · 1 bình luận ·
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 35/100
faye/websocket-driver-ruby#86 · 3 bình luận ·
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 25/100
faye/websocket-driver-ruby#84 · 2 bình luận ·
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 30/100
faye/websocket-driver-ruby#82 · 4 bình luận · 1 reaction ·
Tất cả issue của faye/websocket-driver-ruby
Issue tương tự
-
Feature Feature Parity
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
valkey-io/valkey-glide-ruby#369 ·
Maintainer thường phản hồi trong vòng 2 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 85/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 74/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 90/100
Maintainer thường phản hồi trong vòng 3 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
thewca/worldcubeassociation.org#16088 ·
Maintainer thường phản hồi trong vòng 1 ngày