Improve documentation
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 1/5
- Thời gian dự kiến
- Dưới một giờ
- Mức phù hợp với người mới
- 50/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- ruby
- Lĩnh vực
- documentation
Hướng nghiên cứu
Bắt đầu với các ví dụ trong README.md và so sánh chúng với tài liệu đầy đủ trên trang Rubydoc được liên kết cho Harvesting::Client#clients. Cập nhật README để hướng người đọc đến tài liệu đó, sau đó xác minh rằng liên kết và phần hướng dẫn xung quanh đều rõ ràng.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
I realize that examples in the README.md are not the best way to document the behavior of this gem.
It would be great if we could point people to this page so that they could see complete documentation of the librtary: https://www.rubydoc.info/github/ombulabs/harvesting/Harvesting/Client#clients-instance_method
- Ngôn ngữ chính
- Ruby
- Star
- 29
- Fork
- 30
- 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
- Có Dockerfile hoặc tệp Docker Compose
- Có mẫu pull request
- Không có hướng dẫn đóng góp
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 fastruby/harvesting
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 35/100
fastruby/harvesting#69 ·
-
Line Item ModelsĐang mởFeature Request
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 25/100
fastruby/harvesting#36 · 5 bình luận ·
-
Feature Request
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 38/100
fastruby/harvesting#12 · 4 bình luận ·
Tất cả issue của fastruby/harvesting
Issue tương tự
-
area: cli enhancement
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
Maintainer thường phản hồi trong vòng 1 ngày
-
mail processing verified
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 88/100
Maintainer thường phản hồi trong vòng 7 ngày
-
L: github:actions L: php:composer
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 88/100
dependabot/dependabot-core#16493 ·
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 72/100
doorkeeper-gem/doorkeeper-openid_connect#409 · 1 bình luận ·
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 64/100
puppetlabs/pdk-templates#676 ·
Maintainer thường phản hồi trong vòng 1 ngày