Improve documentation for Attribution
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
- 45/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- python, yaml
- Lĩnh vực
- cli, documentation
Hướng nghiên cứu
Bắt đầu bằng cách tìm tài liệu ABCTK và đầu ra trợ giúp cho lệnh transform, đặc biệt là hàm --help--format được đề cập trong issue. Tổ chức lại tài liệu cấp cao thành các phần Attribution và các tệp ABOUT, đặt attrib và transform dưới Attribution. Công việc được xem là hoàn tất khi nội dung YAML của transform được giải thích trong tài liệu mà không yêu cầu cài đặt ABCTK.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Within the ABCTK documentation, we should make a distinction between the features and functions that operate on ABOUT files and those that do not require ABOUT files - namely Attribution. This means that we should organized the documentation at a high level under either Attribution or ABOUT files. The attrib and transform commands would be under Attribution and the rest under ABOUT files.
We also need a much more detailed explanation of the content of the transform yaml files - this could just be a copy of the help text from the --help--format function. We do not want to required someone to install ABCTK just to understand how the transform can work.
- Ngôn ngữ chính
- Python
- Star
- 100
- Fork
- 48
- 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
- Có Dockerfile hoặc tệp Docker Compose
- Không 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 aboutcode-org/aboutcode-toolkit
-
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 25/100
-
Update PURLDB with all ABCTK releasesCó thể làm lại được @pombredanne đã nhận 595 ngày trước và không có pull request nào đang mở. Đang mởImportant needs design
aboutcode-org/aboutcode-toolkit#582 · 2 bình luận · 3 người được giao ·
-
Enhance `about_resource` to reference multiple files.Có thể làm lại được @chinyeungli đã nhận 248 ngày trước và không có pull request nào đang mở. Đang mở
aboutcode-org/aboutcode-toolkit#566 · 2 bình luận · 1 người được giao ·
-
Create test file with a few hundred itemsCó thể làm lại được @DennisClark đã nhận 1712 ngày trước và không có pull request nào đang mở. Đang mở
aboutcode-org/aboutcode-toolkit#491 · 2 người được giao ·
-
Clean up / Organize codeCó thể làm lại được @sahil-MK2 đã nhận 1731 ngày trước và không có pull request nào đang mở. Đang mở
aboutcode-org/aboutcode-toolkit#483 · 1 bình luận · 2 người được giao ·
Tất cả issue của aboutcode-org/aboutcode-toolkit
Issue tương tự
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 86/100
NousResearch/hermes-agent#147104 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
[oblt-aw][autodoc] Document new required `shared-org-key` input for `obs-aw-dependency-review`Có thể đã có người làm @github-actions đã nhận hôm nay. Đang mở
Độ 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
-
bot-triaged module: inductor oncall: pt2 topic: fuzzer triaged
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
Maintainer thường phản hồi trong vòng 1 ngày
-
getchaintips leaves out the active tip once a header is staged on it, where Core always lists itĐang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 88/100
btclib-org/btclib-node#2158 ·
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 75/100
patrick-hudson/put.gd-desktop#979 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày