[doc-only] Add a short toolshed/README.md#2102
Merged
Merged
Conversation
|
kiwigitops
reviewed
May 19, 2026
kiwigitops
left a comment
There was a problem hiding this comment.
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.tomlpytestconfig, ruff/mypy include rules) so a straytest_-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
pytestcollection andruff/mypychecks; 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
approved these changes
May 19, 2026
github-actions Bot
pushed a commit
that referenced
this pull request
May 20, 2026
Removed preview folders for the following PRs: - PR #2102
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Clarify expectations for the
toolshed/directory as a shared home for useful, best-effort scripts that do not require production-level maintenance.