fix: keep virtualenv and Terraform caches out of olf diagnostics tree
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 88/100
Research direction
Start with tools/olf/olf/commands/diagnostics.py to find how olf diagnostics tree traverses checkout paths, then read tools/olf/tests/test_diagnostics.py for its existing test patterns. Add a unit test using a temporary path with generated directories and a real source file; done means generated paths are pruned during traversal, source paths remain, and output ordering stays deterministic. Run the focused diagnostics tests while iterating.
Written by the indexing model from the issue text.
Description
Why
olf diagnostics tree currently walks every path under the checkout, except .git. With a local .venv, .terraform, or __pycache__, its output becomes noisy and potentially enormous.
Scope
- Prune common generated directories (
.git,.venv,.terraform,__pycache__,.pytest_cache) during traversal, not after building an enormous list. - Preserve source paths and deterministic ordering.
- Add a tmp-path unit test for generated paths plus a real source file.
Acceptance
- Generated directories and their contents are absent from output.
- Valid source files still appear.
- The test avoids traversing the actual checkout.
Start here: tools/olf/olf/commands/diagnostics.py, tools/olf/tests/test_diagnostics.py.
Contributor notes
- Keep this to one focused PR; follow AGENTS.md.
- No Kubernetes cluster should be necessary unless specifically mentioned.
- For Python changes run
uv run --project tools/olf pytest tools/olf/testsanduv run --project tools/olf ruff check tools/olf(or narrower tests while iterating).
- Dominant language
- Python
- Stars
- 26
- Forks
- 6
- Avg merge
- 12h 14m
- Merged PRs (30d)
- 133
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from OpenLakeForge/openlakeforge
-
bug good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
OpenLakeForge/openlakeforge#498 ·
Maintainers usually reply within 1 day
-
bug good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
OpenLakeForge/openlakeforge#497 ·
Maintainers usually reply within 1 day
-
enhancement good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
OpenLakeForge/openlakeforge#494 ·
Maintainers usually reply within 1 day
-
good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
OpenLakeForge/openlakeforge#488 ·
Maintainers usually reply within 1 day
-
good first issue help wanted
Difficulty 1/5 1-3 hours Newbie friendliness 85/100
OpenLakeForge/openlakeforge#486 ·
Maintainers usually reply within 1 day
All issues in OpenLakeForge/openlakeforge
Similar issues
-
follow-up
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
Maintainers usually reply within 1 day
-
Download helper still uses huggingface_hub arguments removed in 1.0: USE_SYMLINKS is silently ignored and every download ends with a WinError 3 linePossibly taken @li-lizhe claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
IPv6 node addresses produce an invalid request URLPossibly taken @RaphaelFakhri claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
typesense/typesense-python#154 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
elastic/elasticsearch-py#3592 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
developmentseed/titiler-cmr#250 · 1 comment ·
Maintainers usually reply within 1 day