README has no run steps or CLI example (#15) - #22
Closed
Param-Harrison wants to merge 3 commits into
Closed
Param-Harrison wants to merge 3 commits into
Param-Harrison wants to merge 3 commits into
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.
Closes #15
Summary
Adds a
## Run itsection toREADME.mdcoveringbun install,bun run dev(served at http://localhost:3200, demo data seeded on first run), and a CLI example (bun run src/cli.ts groups). Also addstests/readme.test.ts, a docs-drift test that keeps these steps accurate.Acceptance criteria
bun test tests/readme.test.ts›README has a Run it section with install, dev and CLI commandsbun test tests/readme.test.ts›documented CLI example lists the demo groups(runsbun run src/cli.ts groupswithSPLITBILL_DB=:memory:; exits 0, printsgoa-tripandflat-4b)bun test tests/readme.test.ts›README dev URL port matches the server default(README port3200matchesprocess.env.PORT ?? 3200insrc/server.ts)make check:tsc --noEmitclean,bun test29 pass / 0 fail, all 9 skills validNon-goals respected
git diff --name-only main...HEADlists onlyREADME.mdandtests/readme.test.ts.src/changed.package.json,bun.lockandMakefileare untouched.## Run itsection, inserted between## What it doesand## Stack. No existing lines changed.SPLITBILL_DB=:memory:. It never touchessplitbill.sqlite.The test that bites
tests/readme.test.ts›README has a Run it section with install, dev and CLI commandsandREADME dev URL port matches the server defaultmain:bun test tests/readme.test.ts→1 pass, 2 fail(expect(start).toBeGreaterThanOrEqual(0), received-1:## Run itnot found)bun test tests/readme.test.ts→3 pass, 0 fail, 11 expect() callsThe CLI test passes either way, as expected: it checks the existing CLI, not README text.
Gate line
auditis advisory and not part ofcheck. It flags existinghonoadvisories, and this PR leavespackage.jsonandbun.lockunchanged.Protected paths touched
noneReviewer findings addressed
make checkrun during review failed the README-section assertions. Cause: the reviewer and verifier ran at the same time in the same worktree, and the verifier had revertedREADME.mdtomainfor its revert test. The test correctly caught the missing section, so this was not a flake. Every later run passed. See the verdict comment on README has no run steps or CLI example #15 for details.Human checklist
🤖 Generated with Claude Code