Fix wrong test commands in CONTRIBUTING.md and trim duplicates#39
Merged
Fix wrong test commands in CONTRIBUTING.md and trim duplicates#39
Conversation
CONTRIBUTING.md claimed `npm test` runs the Python suite via uv (it runs Node tests) and told contributors to use pytest (the project uses unittest — the command failed). Rewrites the file to document both test suites correctly, drop pipeline narratives that duplicate content already in the command files, add the new /tweak:share command, and correct the project structure tree. CLAUDE.md: normalize literal `--` to `—` for consistency with README. Co-Authored-By: Claude <noreply@anthropic.com>
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
1 participant
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.
Summary
The previous CONTRIBUTING.md gave contributors broken commands: it claimed
npm testran the Python suite viauv(it runs Node tests), and told them to invoke single Python tests withpytest(the project usesunittest— the command literally fails). It also duplicated 6-stage and 7-phase pipeline narratives that already live insidecommands/tweak/evaluate.mdandcommands/tweak/analyze-hn-post.md, and omitted the new/tweak:sharecommand added in #38.This PR rewrites CONTRIBUTING.md (~180 → ~120 lines) to:
share.md,assets/,tests/,.github/workflows/,bin/manifest.js,README.md,LICENSE,CLAUDE.md).Share / upload behaviorrow to the "Where to make X kind of change" table.CLAUDE.md: normalizes literal
--to—for consistency with README.Type of change
Test plan
Verified every command in the new Testing section actually works:
npm test— passes (5 tests across frontmatter / install-smoke / pack-smoke).uv run scripts/tests/run_tests.py— passes (127 tests).uv run --with jsonschema python -m unittest scripts.tests.test_compute -v— passes (11 tests).Also re-ran
node bin/install.js --globalto confirm the doc edits don't perturb the install path; install reports the expected counts (4 agents, 4 skills, 8 commands, 10 schemas).Special notes for reviewers
Adjacent README.md gap noticed during the rewrite, left out of scope for this PR: the
/tweak:sharecommand requires the GitHub CLI (gh), mentioned inline at README.md:146, but the formal Prerequisites list at lines 158-159 only declares Claude Code anduv. Worth a follow-up.Generated with Claude Code