pyvec / pyvec/python.cz

Lepší README

Đang mở
#567 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

technical
Ngôn ngữ chính
Python
Star
46
Fork
115
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

Hlavně aby dokumentovalo, jak rozběhat projekt a co je účelem webovky (a co účelem té webovky - už - není). Viz https://github.com/pyvec/python.cz/pull/559

Hlavně zmínit, že skoro všechno je prostě zdokumentováno v dokumentaci MkDocs a hlavně mkdocs-material

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. 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.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu với README và xem xét pull request được tham chiếu #559. Kiểm tra tài liệu MkDocs và mkdocs-material hiện có để tóm tắt cách chạy dự án, website dùng để làm gì và website không còn đảm nhiệm những trách nhiệm nào. Công việc được xem là hoàn tất khi README hướng người đọc đến tài liệu liên quan và trình bày rõ phần thiết lập cũng như mục đích.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
35/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.