docs: document how to run the test suite locally
维护者通常 2 天内回复
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 78/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 活跃
- 技术栈
- python
- 领域
- documentation, testing
调研方向
先从贡献者文档或开发文档开始,然后检查仓库的 pytest 配置和 CI 工作流,以确认既定的命令和依赖项设置。记录依赖项安装、完整的 pytest 运行和针对性的 pytest 运行、跳过测试的原因,以及 CI 测试配置所在的位置;当新贡献者能够在本地复现相关检查时,即视为完成。
由索引模型根据 Issue 内容生成。
描述
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.
- 主要语言
- Python
- 星标
- 760
- 派生
- 166
- 平均合并
- 4 天 3 小时
- 30 天内合并 PR
- 7
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
python-humanize/humanize 的其他 Issue
-
docs: document the contributor testing workflow可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭
难度 2/5 1-3 小时 新手友好度 78/100
python-humanize/humanize#438 ·
维护者通常 2 天内回复
-
intcomma returns scientific notation for large floats可能已有人在做 @TheNetherWatcher 于 5 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 74/100
python-humanize/humanize#431 ·
维护者通常 2 天内回复
-
metric() adds a digit when a value rounds into quetta可能已有人在做 @SashaMIT 于 6 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 75/100
python-humanize/humanize#423 ·
维护者通常 2 天内回复
-
precisedelta() silently drops the sign of negative timedeltas可能已有人在做 @Mukller 于 44 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 72/100
python-humanize/humanize#379 ·
维护者通常 2 天内回复
-
`naturalsize()` raises `ValueError` for custom format strings with text可能已有人在做 @Sanjays2402 于 68 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 75/100
python-humanize/humanize#366 ·
维护者通常 2 天内回复
查看 python-humanize/humanize 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 82/100
RedHatQE/mtv-api-tests#721 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 84/100
维护者通常 1 天内回复
-
难度 1/5 1-3 小时 新手友好度 85/100
pytest-dev/pluggy#757 ·
维护者通常 1 天内回复
-
难度 1/5 1-3 小时 新手友好度 85/100
NousResearch/hermes-agent#134960 ·
维护者通常 1 天内回复
-
HTML backend: `<br>` leaks the internal sentinel U+E000 into list items, headings and captions可能已有人在做 @morten-lagabote 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 67/100
docling-project/docling#4671 ·
维护者通常 1 天内回复