Skip to content

[doc-only] Add a short toolshed/README.md#2102

Merged
kkraus14 merged 1 commit into
NVIDIA:mainfrom
rwgk:add_toolshed_readme
May 19, 2026
Merged

[doc-only] Add a short toolshed/README.md#2102
kkraus14 merged 1 commit into
NVIDIA:mainfrom
rwgk:add_toolshed_readme

Conversation

@rwgk
Copy link
Copy Markdown
Contributor

@rwgk rwgk commented May 18, 2026

Clarify expectations for the toolshed/ directory as a shared home for useful, best-effort scripts that do not require production-level maintenance.

@rwgk rwgk added this to the cuda.pathfinder next milestone May 18, 2026
@rwgk rwgk self-assigned this May 18, 2026
@rwgk rwgk added documentation Improvements or additions to documentation P1 Medium priority - Should do CI/CD CI/CD infrastructure labels May 18, 2026
@rwgk rwgk requested a review from rparolin May 18, 2026 17:01
@github-actions
Copy link
Copy Markdown

Copy link
Copy Markdown

@kiwigitops kiwigitops left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice — having an in-tree note about toolshed/'s scope is a real improvement over the implicit convention.

One question on the "do not warrant CI coverage, unit tests, or the rest of the production-code apparatus" line: is that expectation enforced anywhere today, or only intended? Looking at the existing contents (check_cython_abi.py, check_spdx.py, the build_pathfinder_* family, etc.), some of these look CI-shaped enough that a future contributor might wire one into a workflow by reflex.

Concretely:

  • Is toolshed/ excluded from the test discovery patterns (e.g. pyproject.toml pytest config, ruff/mypy include rules) so a stray test_-prefixed scratch file doesn't accidentally become CI surface?
  • Would it be worth a short bullet in this README spelling out the boundary — e.g. "Files here are excluded from pytest collection and ruff/mypy checks; if a tool graduates past scratchpad status, move it to <canonical-location> first"?

Happy either way — just thinking about how a future reader who only sees this README knows where the guardrails actually live. Not blocking for a doc-only PR.

@kkraus14 kkraus14 merged commit dfa92f3 into NVIDIA:main May 19, 2026
30 of 34 checks passed
@rwgk rwgk deleted the add_toolshed_readme branch May 19, 2026 21:55
github-actions Bot pushed a commit that referenced this pull request May 20, 2026
Removed preview folders for the following PRs:
- PR #2102
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CI/CD CI/CD infrastructure documentation Improvements or additions to documentation P1 Medium priority - Should do

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants