line / line/centraldogma-python
Add simple examples to README.md
Đang mở
Chưa có ai nhận issue này.
documentation
- Ngôn ngữ chính
- Python
- Star
- 21
- Fork
- 11
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
README.md could be a gentle guide for users to start centraldogma-python for the first time.
Examples:
https://github.com/line/centraldogma-go
https://github.com/line/centraldogma-rs
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 với README.md và so sánh tài liệu bắt đầu sử dụng trong các repository centraldogma-go và centraldogma-rs được liên kết. Thêm các ví dụ sử dụng lần đầu đơn giản cho Python client, với đủ ngữ cảnh để người dùng mới có thể làm theo; README cần hướng dẫn rõ ràng quy trình thiết lập và sử dụng lần đầu.
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
- 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
- 45/100