Skip to content

docs: add npm/CI badges + Cost & Performance section, run tests in CI#12

Merged
devplanningo merged 1 commit into
masterfrom
devplanningo/readme-badges-ci-test
Apr 21, 2026
Merged

docs: add npm/CI badges + Cost & Performance section, run tests in CI#12
devplanningo merged 1 commit into
masterfrom
devplanningo/readme-badges-ci-test

Conversation

@devplanningo
Copy link
Copy Markdown
Contributor

Summary

  • Add npm/CI/license/Node badges to both READMEs
  • Add Cost & Performance section with empirical numbers from real DUUL usage in this repo (42 reviewer calls, gpt-5.4, prompt caching enabled)
  • CI workflow now runs npm test after the build step (previously only built)

Cost data added to README

Tool Avg tokens/call Avg cost/call Cache hit rate
plan_review 100,966 $0.065 79%
code_review 179,837 $0.122 79%
Combined avg 132,890 $0.088 79%

Typical task (1–3 plan rounds + 1–2 code rounds) lands around $0.30–$0.50 in reviewer cost. Includes pointer to scripts/token-report.mjs for self-measure.

Why now

  • Package is published to npm (@planningo/duul@1.0.0) but README had no version/release indicators — readers couldn't tell at a glance whether the project was actively published or maintained.
  • CI was building but not running tests. The npm test suite (60 tests, ~135ms) was passing locally; this PR brings CI in line.

Follow-ups noted but not in this PR

  • CHANGELOG.md doesn't exist yet. .changeset/ is set up but npx changeset version hasn't been run. Should be done as part of the next versioned release.
  • Quick Start block at top of README (currently first command appears only inside Installation section).
  • CONTRIBUTING.md if external contributions are expected.
  • Auto GitHub Release notes from changeset action.

Test plan

  • npm test — 60/60 pass locally
  • CI runs new test step on this PR (verify the workflow fires)
  • Badges render correctly on GitHub README
  • Cost table reads correctly in both en/ko READMEs

🤖 Generated with Claude Code

README (en + ko):
- Badges at top: npm version, downloads, license, CI status, Node version
- New "Cost & Performance" section before "How It Works" with empirical
  numbers from real DUUL usage in this repo (42 reviewer calls, gpt-5.4,
  prompt caching enabled): plan_review ~$0.065/call, code_review
  ~$0.122/call, cache hit rate 79%. Includes typical task budget
  ($0.30-$0.50) and pointer to scripts/token-report.mjs for self-measure.

CI:
- Run npm test after the build step. The previous workflow only built,
  so a broken test could have been merged silently.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@devplanningo devplanningo merged commit 78e8615 into master Apr 21, 2026
1 check passed
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.

1 participant