testcontainers / testcontainers/testcontainers-python
Docs: Improve docs with examples
Đang mở
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 2.3k
- Fork
- 386
- Merge trung bình
- 4 giờ 40 phút
- Pull request đã merge (30 ngày)
- 1
Mô tả
What are you trying to do?
I am trying to implement testcontainer in python but struggling to understand the flow
Why should it be done this way?
- Add examples in the landing page
- Examples for each mantained module
- Examples with pytest
Extra Info
I will try to do a PR
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 đọc landing page và tài liệu của từng module được duy trì để xác định cấu trúc hiện tại và các ví dụ còn thiếu. Thêm các ví dụ sử dụng Python, bao gồm cả các ví dụ dựa trên pytest, vào landing page và các module; công việc được hoàn thành khi các ví dụ bao quát những khu vực được yêu cầu và dễ hiểu đối với người đang học quy trình.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- docker, python
- Lĩnh vực
- documentation
- Loại issue
- Tài liệu
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức độ hoạt động
- Ít trao đổi
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 45/100