docs: add npm/CI badges + Cost & Performance section, run tests in CI#12
Merged
Merged
Conversation
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>
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
npm testafter the build step (previously only built)Cost data added to README
plan_reviewcode_reviewTypical task (1–3 plan rounds + 1–2 code rounds) lands around $0.30–$0.50 in reviewer cost. Includes pointer to
scripts/token-report.mjsfor self-measure.Why now
@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.npm testsuite (60 tests, ~135ms) was passing locally; this PR brings CI in line.Follow-ups noted but not in this PR
CHANGELOG.mddoesn't exist yet..changeset/is set up butnpx changeset versionhasn't been run. Should be done as part of the next versioned release.CONTRIBUTING.mdif external contributions are expected.Test plan
npm test— 60/60 pass locally🤖 Generated with Claude Code