Gem docs are extremely lacking
@ess đang làm issue này rồi.
Từ ngày 14/4/2020.
Đánh giá
Issue này chưa được đánh giá.
Mô tả
Here are a few documentation issues that have been highlighted specific to this gem:
- The primary CLI app that customers use to interact with their Engine Yard assets now lives in this project, but there is not even a mention of that in the docs, let alone usage instructions
- Aside from a few examples, there are no actual library usage instructions within the gem
- There is almost zero actual library documentation (as one might find on https://rubydoc.info )
- As @lucis-fluxum points out in #109 , the actual API docs listed at https://developer.engineyard.com are missing information and are generally inconsistent. That issue belongs to another project, but it directly impacts this project as well, so we are making note of this here
- Ngôn ngữ chính
- Ruby
- Star
- 4
- Fork
- 19
- 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 engineyard/core-client-rb
-
Parsing documentation on gem install failsCó thể đã có người làm Có pull request liên kết đang mở hoặc đã được merge. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 62/100
engineyard/core-client-rb#136 ·
-
Docker setup documentation issueĐang mởdocker documentation
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 48/100
engineyard/core-client-rb#144 ·
-
bug: the environments api URL is returning a bad list of matching environments to environments.rbĐang mở
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 42/100
engineyard/core-client-rb#142 · 1 bình luận ·
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 45/100
engineyard/core-client-rb#141 ·
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 35/100
engineyard/core-client-rb#140 · 1 bình luận ·
Tất cả issue của engineyard/core-client-rb
Issue tương tự
-
documentation
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
alphagov/tech-docs-gem#580 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Onboarding form: instructor radio never pre-selected "Yes" (permission vs permissions typo)Có thể đã có người làm @ThakuraAnki đã nhận hôm nay. Đang mởbug
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 72/100
WikiEducationFoundation/WikiEduDashboard#7235 ·
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 70/100
Maintainer thường phản hồi trong vòng 1 ngày
-
enhancement priority: low
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
davidteren/mutineer#361 ·
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 86/100
zerocracy/judges-action#3021 ·
Maintainer thường phản hồi trong vòng 2 ngày