Update docs
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- 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ệ
- elixir
- Lĩnh vực
- documentation, testing
Hướng nghiên cứu
Xem lại tài liệu và các ví dụ của repository, đồng thời đọc issue #63 để nắm ngữ cảnh của doctest. Được xem là hoàn tất khi tài liệu được cập nhật, các ví dụ có thể chạy phù hợp được doctest bao phủ và có các typespecs hữu ích ở những nơi thích hợp; Credo và Dialyzer là các công cụ phân tích được tham chiếu.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
We should make sure:
- the docs are kept up-to-date
- examples that can be run as unit tests (because they don't have side-effects or require a complex set-up) should be tested with
doctest(see #63) - typespecs; these aren't checked by the compiler but can be very useful documentation. They are checked by static code analysis tools like credo and dialyzer).
- Ngôn ngữ chính
- Elixir
- Star
- 17
- Fork
- 3
- 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
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 liquidvotingio/api
-
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 35/100
liquidvotingio/api#252 · 1 bình luận ·
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 25/100
liquidvotingio/api#250 ·
-
Proposal collection reference fieldCó thể làm lại được @oliverbarnes đã nhận 1979 ngày trước và không có pull request nào đang mở. Đang mở
liquidvotingio/api#245 · 3 bình luận · 1 người được giao ·
-
Make better use of Multi.runĐang mở
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 48/100
liquidvotingio/api#237 ·
-
Make global delegations explicitĐang mở
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 25/100
liquidvotingio/api#234 · 1 bình luận ·
Tất cả issue của liquidvotingio/api
Issue tương tự
-
Cainophile EXIT handler crashes on its own password redaction and logs the DB password in clear textĐang mở
Độ 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 2 ngày
-
Bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
wintermeyer/vutuv#2318 ·
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 84/100
beyond-all-reason/teiserver#1624 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
enhancement javascript
Độ 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
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
phoenixframework/phoenix_template#15 · 1 bình luận ·