DOCUMENTATION: add package level documentation and files level documentation for all files
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ệ
- go
- Lĩnh vực
- documentation
Hướng nghiên cứu
Rà soát package Go và tất cả các tệp trong repository để lập danh mục tài liệu còn thiếu ở cấp package và cấp tệp. Ghi lại mục đích của từng tệp, giải thích mối liên hệ giữa các khái niệm chính và mô tả cách sử dụng API công khai; để hoàn thành, cần bao quát tất cả các tệp và các khái niệm ở cấp package được mô tả trong issue.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Add documentation explaining major concepts and purpose for each file.
Add package level documentation that describes interconnections between major concepts in different files and how to use public API.
_NOTE: Use Go for identifying the go language. There is at least one use of GO in the code documentation.`
- Ngôn ngữ chính
- Go
- Star
- 55
- Fork
- 18
- Merge trung bình
- 5 giờ 55 phút
- Pull request đã merge (30 ngày)
- 3
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 github/go-spdx
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 65/100
-
fix noisy update license PRCó thể đã có người làm @elrayle đã nhận 277 ngày trước. Đang mở
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 38/100
-
Update processing to comply with SPDX spec 3.xCó thể làm lại được @deo002 đã nhận 167 ngày trước và không có pull request nào đang mở. Đang mở
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 35/100
-
maintenance
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 45/100
-
refactor
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 42/100
Tất cả issue của github/go-spdx
Issue tương tự
-
ViewData can pair the in-flight proposal with the prepared flag of another proposalCó thể đã có người làm @HagarMeir đã nhận hôm nay. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
hyperledger/SmartBFT#710 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
agent-butler-finding chore
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 90/100
jordansmall/spindrift#5575 ·
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
open-telemetry/opentelemetry-go-compile-instrumentation#1512 ·
Maintainer thường phản hồi trong vòng 3 ngày
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 85/100
slavakurilyak/awesome-ai-agents#805 ·
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
JakeChampion/lang#12684 ·
Maintainer thường phản hồi trong vòng 1 ngày