Create guidelines for README 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
- 30/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ệ
- markdown
- Lĩnh vực
- documentation
Hướng nghiên cứu
Trước tiên, hãy xem xét các tệp README của repository và cấu trúc Docusaurus/Markdown của repository, sau đó so sánh chúng với các phương pháp hay liên quan của cộng đồng. Xác định cấu trúc README được chuẩn hóa và ghi lại các hướng dẫn để thông tin thiết yếu nhất quán trên tất cả các dự án AboutCode.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Create a standardized structure for README files across AboutCode projects, aligning with community best practices. By developing a consistent format, we can enhance clarity, improve user onboarding, and ensure that essential information is easily accessible.
- Ngôn ngữ chính
- JavaScript
- Star
- 9
- Fork
- 17
- Merge trung bình
- 7 giờ 55 phút
- Pull request đã merge (30 ngày)
- 2
Chuẩn bị môi trường
Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.
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/www.aboutcode.org
-
Making all post button.Có thể đã có người làm @sarthaklole đã nhận 70 ngày trước. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
aboutcode-org/www.aboutcode.org#117 · 3 bình luận ·
-
WWW: Reduce frequency of update-releasesCó thể làm lại được @johnmhoran đã nhận 51 ngày trước và không có pull request nào đang mở. Đang mởci-workflow
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 45/100
aboutcode-org/www.aboutcode.org#180 · 1 người được giao ·
-
DOCS: Create new AboutCode stack diagram(s)Có thể làm lại được @hixvikas đã nhận 52 ngày trước và không có pull request nào đang mở. Đang mởdocumentation
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 35/100
aboutcode-org/www.aboutcode.org#166 · 1 bình luận ·
-
WWW: Create About top level page?Có thể đã có người làm @pombredanne đã nhận 154 ngày trước. Đang mởwebsite
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 35/100
aboutcode-org/www.aboutcode.org#164 · 1 reaction · 1 người được giao ·
-
WWW: Add Initiatives and grant ProjectsCó thể làm lại được @mjherzog đã nhận 240 ngày trước và không có pull request nào đang mở. Đang mởenhancement needs design website
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 25/100
aboutcode-org/www.aboutcode.org#141 · 1 người được giao ·
Tất cả issue của aboutcode-org/www.aboutcode.org
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
wazuh/wazuh-documentation#10584 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
documentation good first issue
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 94/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
InukaAsith/TwinDesk#84 ·
Maintainer thường phản hồi trong vòng 2 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
Graphify-Labs/graphify#4860 · 1 bình luận ·
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 65/100
CommandCodeAI/command-code#1088 ·
Maintainer thường phản hồi trong vòng 2 ngày