Repository navigation
docs: add CLAUDE.md as a short card - #12
Merged
Merged
Conversation
This repo had no CLAUDE.md. The card is what a session reads first here: what the repo is, the gate in the order to run it, the hazard (a starter gets copied into production, so its data stays synthetic and its patterns safe), and two rules, each with the pull request whose failure proved it: regenerate a lockfile from scratch on a version move (#8), and a README says only what its starter runs and asserts (#7, #10). Co-Authored-By: Claude Opus 5.5 <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
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.
What and why
This repo had no CLAUDE.md. This adds one as a short card (45 lines), the first thing a session reads here: what the repo is, the gate in the order to run it, the hazard, and the rules that bind. Nothing else changes.
The two rules come from this repo's own pull requests: #8 (cli-tour's old lockfile held
@cosyte/fhir0.0.10, which every peer range still accepted, so the lockfile is regenerated from scratch on a version move) and #7 and #10 (README claims narrowed to what the starters run and assert). There was no old CLAUDE.md,documentation/agent-notes*,CONTRIBUTING.mdorCHANGELOG.mdto carry rules over from.Every command the card names, and how we checked it (checked, not run)
bash scripts/check-no-emdash.shbashon PATH (command -v bash);git ls-files scripts/check-no-emdash.sh--stdinmode"${1:-}" = "--stdin"branchnpm cinpmon PATH (command -v npm)npm testtestscript in all 10 starters'package.json(jq -r '.scripts | keys[]')npm startstartscript in all 10 starters'package.jsongit ls-files -- '*/package.json' | awk -F/ 'NF == 2 { print $1 }'gitandawkon PATH; the same line asstarters.yml's discover step; it lists the 10 startersmise exec node@22 -- npm ci,mise exec node@22 -- npm testmiseon PATH (command -v mise); under itnode --versionprints v22.23.3rm -rf node_modules package-lock.json && npm installrmon PATH;npm installis an npm built-innpm ls --allPaths it names, each listed by
git ls-files:scripts/check-no-emdash.sh,.github/workflows/no-emdash.yml,.github/workflows/starters.yml. There is no rootpackage.json, so the card names no root script.The checks it names (
no-emdash,All starters) are the two contextsgh api repos/cosyte/examples/rules/branches/mainlists as required, and that ruleset allows squash merges only, which is why the card says the PR title and body become the commit onmain.How it was checked
wc -l < CLAUDE.md: 45.bash scripts/check-no-emdash.shwith CLAUDE.md staged: OK.rg -n '[\x{2013}\x{2014}]'over CLAUDE.md, the commit message and this body: nothing.npm cithennpm test, on Node 24.22.0 and on Node 22.23.3 (mise exec node@22): 20 of 20 pass, 45 tests per Node line, 0 fail.Harness-Task: 80
🤖 Generated with Claude Code