docs: document how to run the test suite locally
Maintainer thường phản hồi trong vòng 2 ngày
Đánh giá
- Độ khó
- 2/5
- Thời gian dự kiến
- 1-3 giờ
- Mức phù hợp với người mới
- 78/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Sôi nổi
- Công nghệ
- python
- Lĩnh vực
- documentation, testing
Hướng nghiên cứu
Bắt đầu với tài liệu dành cho contributor hoặc tài liệu phát triển, sau đó kiểm tra cấu hình pytest và CI workflow của repository để xác nhận các lệnh đã được thiết lập và cách thiết lập dependency. Ghi lại việc cài đặt dependency, các lần chạy pytest toàn bộ và tập trung, lý do các test bị bỏ qua, cũng như vị trí của cấu hình test CI; công việc được xem là hoàn tất khi một contributor mới có thể tái hiện các bước kiểm tra liên quan trên máy cục bộ.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Problem
When working on a test contribution, I had to inspect the repository's test configuration and CI workflow to determine how to run the same test suite locally.
The project has an established pytest-based test suite, but as a new contributor, I initially had to investigate the repository configuration to understand the expected local testing workflow.
Proposed documentation
Add a short section to the contributor/development documentation explaining:
- how to install the test dependencies
- how to run the complete test suite
- how to run a specific test file
- how to run a focused test using pytest's
-koption - why some tests may be skipped
- where contributors can find the CI test configuration
Who this is for
This is intended for new contributors making their first test-related change who need to verify their changes locally before opening a pull request.
Why I am proposing this
This is based on a real point where I was confused during my test contribution. I had to inspect the project's test configuration and CI workflow to understand how local pytest execution related to the automated checks on a pull request.
- Ngôn ngữ chính
- Python
- Star
- 761
- Fork
- 185
- Merge trung bình
- 4 ngày 3 giờ
- Pull request đã merge (30 ngày)
- 7
Chuẩn bị môi trường
- Không có Dockerfile hay tệp Docker Compose
- Có mẫu pull request
- Đọc 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.
Issue khác của python-humanize/humanize
-
docs: document the contributor testing workflowCó thể đã có người làm @harmehak0173 đã nhận 3 ngày trước. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
python-humanize/humanize#438 ·
Maintainer thường phản hồi trong vòng 2 ngày
-
intcomma returns scientific notation for large floatsCó thể đã có người làm @TheNetherWatcher đã nhận 8 ngày trước. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 74/100
python-humanize/humanize#431 ·
Maintainer thường phản hồi trong vòng 2 ngày
-
metric() adds a digit when a value rounds into quettaCó thể đã có người làm @SashaMIT đã nhận 9 ngày trước. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
python-humanize/humanize#423 ·
Maintainer thường phản hồi trong vòng 2 ngày
-
precisedelta() silently drops the sign of negative timedeltasCó thể đã có người làm @Mukller đã nhận 47 ngày trước. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
python-humanize/humanize#379 ·
Maintainer thường phản hồi trong vòng 2 ngày
-
`naturalsize()` raises `ValueError` for custom format strings with textCó thể đã có người làm @Sanjays2402 đã nhận 71 ngày trước. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
python-humanize/humanize#366 ·
Maintainer thường phản hồi trong vòng 2 ngày
Tất cả issue của python-humanize/humanize
Issue tương tự
-
area:space-accuracy good first issue track:data
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 85/100
Sara-Managed-Projects/space-radar#904 ·
Maintainer thường phản hồi trong vòng 1 ngày