DOC: update contributing guide to reflect the preferred practice
Đang mở
Chưa có ai nhận issue này.
documentation
infrastructure
- Ngôn ngữ chính
- Không có dữ liệu ngôn ngữ
- Star
- 673
- Fork
- 229
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
Currently missing points:
- No outputs should be included in the notebooks
- we do prefer
.mdfiles as opposed to.ipynb.
Maybe the updated guide should be in a separate file, and keep the absolute newcomer version, that we currently have, in the README?
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.
Hướng nghiên cứu
Đọc hướng dẫn đóng góp hiện tại và README để xem các thực hành về notebook được ghi lại ở đâu. Cập nhật hướng dẫn để nêu rõ rằng notebook không được chứa output và các tệp .md được ưu tiên hơn .ipynb; công việc được xem là hoàn tất khi cấu trúc hướng dẫn được chọn phản ánh rõ cả hai điểm.
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