OpenFreeEnergy / OpenFreeEnergy/openfe
cli yaml: implement auto documenter
Đang mở
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 331
- Fork
- 56
- Merge trung bình
- 3 ngày 9 giờ
- Pull request đã merge (30 ngày)
- 13
Mô tả
ideally we can generate example yaml files for the CLI from the CLI, that can then be customised then used
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
Bắt đầu bằng cách xác định các điểm vào của CLI phân tích cấu hình YAML. Xác định cách một lệnh auto-documenter nên tạo các tệp YAML mẫu có thể được tùy chỉnh và sau đó được CLI chấp nhận. Công việc được xem là hoàn tất khi các ví dụ được tạo có thể sử dụng làm đầu vào CLI và bao quát các tùy chọn cấu hình dự kiến.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- python
- Lĩnh vực
- cli, documentation
- Loại issue
- Tính năng
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- 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