Clean up the repo README
Maintainer thường phản hồi trong vòng 1 ngày
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức phù hợp với người mới
- 65/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Sôi nổi
- Lĩnh vực
- documentation
Hướng nghiên cứu
Start with the repository README and compare it with the documentation in the doc folder, including the development setup material. Add a linked table of contents, move longer inline sections to the appropriate documentation, and resolve discrepancies so the README and doc folder agree.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
ideas:
- make a table of contents with links at the top.
- link to longer documentation (like dev setup) instead of inlining it.
- look for overlap with the doc folder and resolve any discrepancies too.
- Ngôn ngữ chính
- Java
- Star
- 16
- Fork
- 5
- Merge trung bình
- 14 giờ 45 phút
- Pull request đã merge (30 ngày)
- 25
Chuẩn bị môi trường
Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.
- Không có Dockerfile hay 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 CodeForPhilly/benefit-decision-toolkit
-
Make docs website more visibleĐang mởdocumentation Good for newcomer quick win
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
CodeForPhilly/benefit-decision-toolkit#519 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
documentation quick win
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
CodeForPhilly/benefit-decision-toolkit#445 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Make issue templatesĐang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
CodeForPhilly/benefit-decision-toolkit#425 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Update docs screenshots to reflect new navigation design and use the actual in-app example screenerĐang mở
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 55/100
CodeForPhilly/benefit-decision-toolkit#528 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 45/100
CodeForPhilly/benefit-decision-toolkit#524 ·
Maintainer thường phản hồi trong vòng 1 ngày
Tất cả issue của CodeForPhilly/benefit-decision-toolkit
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 84/100
beehive-lab/TornadoVM#1151 ·
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 88/100
Maintainer thường phản hồi trong vòng 1 ngày
-
(cbor) `maxStringLength` not consistently checked for chunked (indefinite-length) text valuesĐang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 77/100
FasterXML/jackson-dataformats-binary#823 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 90/100
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 78/100
Maintainer thường phản hồi trong vòng 1 ngày