[mkdocs] Improve descriptions
Đang mở
Chưa có ai nhận issue này.
documentation
P2
- Ngôn ngữ chính
- Python
- Star
- 18.8k
- Fork
- 2.8k
- Merge trung bình
- 16 giờ 26 phút
- Pull request đã merge (30 ngày)
- 21
Mô tả
Looking at https://github.com/daexs/plotly.py/pull/80/files, some of the descriptions are very short and not informative.
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 xem xét các thay đổi về tệp và phần mô tả được thể hiện trong pull request được tham chiếu. Xác định những phần mô tả quá ngắn hoặc thiếu thông tin, sau đó cập nhật chúng để tài liệu liên quan rõ ràng hơn; công việc được xem là hoàn tất khi các phần mô tả liên quan cung cấp ngữ cảnh hữu ích mà không quá ngắn gọn một cách không cần thiết.
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ó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Cần làm rõ
- Mức phù hợp với người mới
- 35/100