Skip to content

README has no run steps or CLI example (#60) - #73

Open
Param-Harrison wants to merge 2 commits into
mainfrom
factory/issue-60
Open

Param-Harrison wants to merge 2 commits into
mainfrom
factory/issue-60

Conversation

@Param-Harrison

Copy link
Copy Markdown
Contributor

Summary

Adds a "Run it" section to README.md with bun install, bun run dev (http://localhost:3200) and a CLI example (bun run src/cli.ts groups), plus tests/readme.test.ts so the documented commands stay true to the repo.

Closes #60

Plan

Plan comment (.factory/runs/issue-60/plan-comment.md, rev 1):

  • AC-1 ## Run it section with bun install, verified by bun test tests/readme.test.ts
  • AC-2 bun run dev and http://localhost:3200 match package.json and the src/server.ts default port, verified by bun test tests/readme.test.ts
  • AC-3 CLI example bun run src/cli.ts groups runs against a seeded in-memory DB, verified by bun test tests/readme.test.ts
  • AC-4 full gate stays green, verified by make check

Non-goals: no changes under src/, public/, package.json, bun.lock or Makefile; no protected paths, AGENTS.md or DEMO.md; no rewrite of existing README sections.

Gate evidence

FACTORY_GATES: status=GREEN passed=3 failed=0 skipped=1 failed_gates=audit

Verify verdict

Verdict: pass (verdict comment, .factory/runs/issue-60/verdict-comment.md). All four ACs pass. The new tests fail with README.md restored from main (0 pass, 3 fail) and pass on this branch (3 pass, 0 fail). Two non-blocking "could" findings: the port check greps the src/server.ts source, and only the groups command is executed by the test.

Risk and rollback

low: docs plus a new test file, with no schema, API or protected-path change. Roll back by reverting the commit; nothing else depends on it.

Factory run

Stage Agent Duration Tool calls Cost Outcome
triage claude 16s 4 $0.08 ok
plan claude 32s 5 $0.25 ok
build claude 1m 5s 13 $0.31 ok
verify claude 1m 20s 18 $0.47 pass
pr claude 19s 6 $0.09 ok

5 stage runs, 3m 32s, $1.21.

Went well

  • triage, plan, build, verify, pr passed on the first attempt
  • verify approved on the first round

Needed help

  • nothing

@Param-Harrison
Param-Harrison marked this pull request as ready for review October 8, 2026 21:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README has no run steps or CLI example

1 participant