Align contributor test guidance with stdlib unittest#143
Merged
Conversation
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.
Non-technical summary
This tightens the contributor path around test execution so the instructions match what clauck actually supports in a clean checkout. Right now two test modules tell contributors to use
pytest, but the repo and CI both rely on the Python standard libraryunittestrunner instead.This matters now because a fresh environment can successfully validate the repo without installing extra tooling, but the stale guidance sends contributors down a failing path first.
Technical summary
Run:guidance intests/test_clauck.pyto usepython3 -m unittest tests.test_clauckRun:guidance intests/test_clauck_cron.pyto usepython3 -m unittest tests.test_clauck_cronCONTRIBUTING.mdso the documented validation path matches CI and the repository's minimal-dependency contractValidation
/usr/bin/python3 -m unittest discover tests -vAdditional notes
Trade-off: this is intentionally scoped to the misleading invocation surfaces rather than broad contributor-doc cleanup.
Deferred follow-up: none required inside this slice; broader documentation rework would be a separate increment if needed.
Remaining gap to fuller vision: the repo still relies on scattered inline
Run:hints across tests, so future drift is still possible unless that guidance is centralized later.