improve repo documentation
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức phù hợp với người mới
- 30/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ệ
- rust
- Lĩnh vực
- documentation
Hướng nghiên cứu
Start by inspecting the repository's existing README, internal documentation, test and coverage reporting, workflows, and release configuration. Document the introduction, production and development usage, contribution setup, testing, workflows, and release process listed in the checklist; done means each requested topic is covered or linked.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
checklist
- have an introduction to the project
- show status of the tests and code coverage
- how to run in production e.g if it was a binary or something the enduser needs to download
- how to run in development as a developer (it's fine to link to another page)
- should have a link to internal docs for development
- how to get the code
- how to configure the editor/IDE
- how to run the tests
- how to write new tests
- have the workflows documented
- have the releasing process documented
- Ngôn ngữ chính
- Rust
- Star
- 17
- Fork
- 3
- 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
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 threefoldtech/zinit
-
Support CPU and memory usage to service statusCó thể làm lại được @mahmoud-emad đã nhận 561 ngày trước và không có pull request nào đang mở. Đang mởtype_feature
threefoldtech/zinit#72 · 1 người được giao ·
-
logging to filesystemCó thể đã có người làm @maximevanhees đã nhận 733 ngày trước. Đang mở
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 35/100
threefoldtech/zinit#68 ·
-
check how easy is it to add cron scheduling to zinitCó thể đã có người làm @maximevanhees đã nhận 745 ngày trước. Đang mở
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 25/100
threefoldtech/zinit#66 ·
-
workdirĐang mở
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 35/100
threefoldtech/zinit#65 ·
-
stop dependenciesĐang mở
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 42/100
threefoldtech/zinit#64 ·
Tất cả issue của threefoldtech/zinit
Issue tương tự
-
Độ 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
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
swc-project/swc#12576 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
good first issue gpu serve
Độ 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
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
biomejs/biome#12475 · 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 80/100
Maintainer thường phản hồi trong vòng 1 ngày