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ệ
- github-actions, python
- Lĩnh vực
- ci-cd, documentation
Hướng nghiên cứu
Bắt đầu bằng việc lập danh mục các project, component, cùng các function và class quan trọng trong libs, sau đó xem xét các file README và workflow hiện có của repository. Xác định phạm vi tài liệu, hướng dẫn cài đặt và chạy, cấu hình Sphinx, cùng các bước publish lên GitHub Pages trước khi triển khai chúng. Được xem là hoàn tất khi tất cả project và component được yêu cầu đều có phần tổng quan và hướng dẫn, các API quan trọng trong libs có docstring, và tài liệu được tạo ra được publish thông qua workflow.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Create READMEs for all projects and components, including installation and running instructions as well as overviews of functionality.
Create docstrings for all functions and classes of importance in libs and use Sphinx+GitHub workflows to automatically generate documentation which gets pushed to a GitHub page.
- Ngôn ngữ chính
- Python
- Star
- 11
- Fork
- 6
- 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
- Không có Dockerfile hay tệp Docker Compose
- Không có mẫu pull request
- Đọ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 ML4GW/DeepClean
-
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 15/100
-
question research topic
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 20/100
-
enhancement
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 45/100
-
bug documentation good first issue
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 45/100
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 35/100
Tất cả issue của ML4GW/DeepClean
Issue tương tự
-
idxmax/idxmin raise ValueError when a single partition is all-NACó thể đã có người làm @Jason10191019999 đã nhận hôm nay. Đang mởneeds triage
Độ 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 3 ngày
-
Old versions of datamodelsĐang mởbug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 64/100
-
[BUG]: Windows GUI package of v1.17.0-rc3 has no GTK DLLsCó thể đã có người làm @andrut-ds đã nhận hôm nay. Đang mởbug CI/CD Pactus-GUI Windows
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
pactus-project/pactus#2428 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
DiskDataset.reshard() can hang with a zero or negative shard sizeCó thể đã có người làm @Programmer-Develops đã nhận hôm nay. Đ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 19 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 66/100
GNS3/gns3-server#3017 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày