docs: document the contributor testing workflow
維護者通常 1 天內回覆
評估
- 難度
- 2/5
- 預估耗時
- 1-3 小時
- 新手友好度
- 78/100
- Issue 類型
- 文件
- 描述清晰度
- 基本清楚
- 活躍度
- 活躍
- 技術堆疊
- python
研究方向
首先定位貢獻者文件以及針對 humanize.clamp() 的現有 pytest 測試，並以 issue #429 作為範例參考。新增一個簡短的章節，涵蓋測試探索、儲存庫慣例、參數化案例、針對性測試與完整測試套件的指令，以及回歸驗證；當首次貢獻者能清楚理解這個工作流程時，即視為完成。
由索引模型根據 Issue 內容生成。
描述
Problem
As a first-time contributor, I found it difficult to determine the
expected workflow for adding and verifying tests.
While working on #429, I had to figure out:
- how to find the appropriate test file
- how to follow the repository's existing pytest conventions
- how to run focused tests
- how to run the full test suite
- how to verify that a regression test actually fails when the
protected behavior is broken
The current contributor documentation does not explain this workflow
for someone making their first test contribution.
Proposed change
Add a short contributor-testing section explaining how to:
- Find the relevant existing test file.
- Follow the repository's existing test patterns.
- Add parameterized test cases where appropriate.
- Run the relevant tests locally.
- Intentionally verify that the test catches a regression.
- Run the full test suite before opening a PR.
The section would use a small example based on the existing test suite.
Motivation
I encountered this while working on #429, where I added parameterized
tests for two-sided humanize.clamp() boundary behavior.
I also intentionally introduced a regression to verify that the new
test failed, then restored the implementation and ran the full suite.
Related PR: #429
- 主要語言
- Python
- 星號
- 761
- 分支
- 185
- 平均合併
- 1 小時 42 分鐘
- 30 天內合併 PR
- 5
環境準備
- 沒有 Dockerfile 或 Docker Compose 檔案
- 有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
python-humanize/humanize 的其他 Issue
-
intcomma returns scientific notation for large floats可能已有人在做 @TheNetherWatcher 於 11 天前認領。 未關閉
難度 2/5 1-3 小時 新手友好度 74/100
python-humanize/humanize#431 ·
維護者通常 1 天內回覆
-
docs: document how to run the test suite locally可能已有人在做 @yuefdev 於 11 天前認領。 未關閉
難度 2/5 1-3 小時 新手友好度 78/100
python-humanize/humanize#430 ·
維護者通常 1 天內回覆
-
metric() adds a digit when a value rounds into quetta可能已有人在做 @SashaMIT 於 12 天前認領。 未關閉
難度 2/5 1-3 小時 新手友好度 75/100
python-humanize/humanize#423 ·
維護者通常 1 天內回覆
-
precisedelta() silently drops the sign of negative timedeltas可能已有人在做 @Mukller 於 50 天前認領。 未關閉
難度 2/5 1-3 小時 新手友好度 72/100
python-humanize/humanize#379 ·
維護者通常 1 天內回覆
-
`naturalsize()` raises `ValueError` for custom format strings with text可能已有人在做 @Sanjays2402 於 74 天前認領。 未關閉
難度 2/5 1-3 小時 新手友好度 75/100
python-humanize/humanize#366 ·
維護者通常 1 天內回覆
查看 python-humanize/humanize 的全部 Issue
相似的 Issue
-
vis.image() reports "Unsupported number of image channels: 224" for an HxWxC image可能已有人在做 @piyush182004 今天認領。 未關閉
難度 2/5 1-3 小時 新手友好度 62/100
fossasia/visdom#1997 · 3 則留言 ·
維護者通常 6 天內回覆
-
Byse new domain未關閉
難度 2/5 1-3 小時 新手友好度 62/100
Gujal00/ResolveURL#1525 ·
維護者通常 1 天內回覆
-
Serialisation fails with pydantic 2.14: wrap serialisers pass SerializationInfo as index_key可能已有人在做 @hugohills-regnosys 今天認領。 未關閉
難度 2/5 1-3 小時 新手友好度 82/100
finos/rune-python-runtime#45 ·
-
[Bug]: LangGraph Store sync put bypasses namespace validation可能已有人在做 @ktz03 今天認領。 未關閉
難度 2/5 1-3 小時 新手友好度 72/100
volcengine/OpenViking#6050 ·
維護者通常 1 天內回覆
-
bug
難度 2/5 1-3 小時 新手友好度 72/100
hummingbot/condor#283 ·
維護者通常 1 天內回覆