Repository navigation
README has no run steps or CLI example (#159) - #166
Closed
Param-Harrison wants to merge 2 commits into
Closed
Param-Harrison wants to merge 2 commits into
Param-Harrison wants to merge 2 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.
Summary
Add a "Run it" section to
README.mdwith the install, dev-server and CLI steps, each working as written on a clean clone.Closes #159
Plan
Plan comment (rev 1) on the issue thread:
## Run itlistsbun install, verified bybun test tests/readme.test.tsbun run devandhttp://localhost:3200(matchesPORT ?? 3200insrc/server.ts), verified bybun test tests/readme.test.tsbun run src/cli.ts groups, verified bybun test tests/readme.test.tsgoa-tripin stdout withSPLITBILL_DB=:memory:, verified bybun test tests/readme.test.tsmake checkNon-goals kept: no changes under
src/,package.json,Makefile,bun.lock, protected paths orAGENTS.md; existing README sections not rewritten.Gate evidence
FACTORY_GATES: status=GREEN passed=3 failed=0 skipped=1 failed_gates=audit(The non-required
auditgate was skipped, not failed.)Verify verdict
Verdict comment on the issue thread: pass, AC-1 to AC-5 all pass, no reviewer findings. The section tests fail on the base branch with an assertion failure (no
## Run itheading,Expected: >= 0, Received: -1) and pass here (4 pass, 0 fail). The CLI-run test checks existing behaviour, so it also passes on base.Risk and rollback
Low: docs-only plus one new test file, no protected path, no API or schema change. Roll back by reverting this PR; nothing else depends on it.
Factory run
5 stage runs, 3m 24s, $0.97.
Went well
Needed help