OpenFreeEnergy / OpenFreeEnergy/ExampleNotebooks

Update READMEs

Đang mở
#48 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.

Ngôn ngữ chính
Jupyter Notebook
Star
70
Fork
15
Merge trung bình
10 giờ 42 phút
Pull request đã merge (30 ngày)
2

Mô tả

The main readme needs to be updated, and we need secondary readmes to explain why a notebook exists (in addition to explanation in the notebook itself).

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 chính và các tệp README phụ hiện có nằm cùng với các notebook. Cập nhật README chính và đảm bảo mỗi README phụ giải thích lý do notebook tương ứng tồn tại. Công việc được hoàn tất khi cả phần tổng quan và mục đích riêng của từng notebook đều được ghi lại.

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

Đánh giá

Công nghệ
jupyter-notebook
Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
3/5
Thời gian dự kiến
1-2 ngày
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
45/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.