Repository navigation
chore: polish public repository and add CI - #1
Merged
Merged
Conversation
There was a problem hiding this comment.
🟢 Approval recommended
The only finding is a non-blocking README anchor-link nit; the reviewed changes are otherwise approval-ready.
Pull request overview
Polishes the repository presentation, adds contribution guidance, and introduces CI verification for the deterministic evaluation pipeline.
Changes:
- Adds CI checks for typechecking, tests, and the evaluation gate.
- Updates Node.js requirements to
>=22.12. - Improves README documentation and adds contribution guidance.
File summaries
| File | Summary |
|---|---|
README.md |
Updated presentation, badges, benchmark context, and requirements; contains one non-blocking anchor-link nit. |
package.json |
Updated Node.js engine requirement. |
package-lock.json |
Synchronized engine metadata. |
CONTRIBUTING.md |
Added contribution and verification guidance. |
.github/workflows/ci.yml |
Added automated CI workflow. |
Review details
Suppressed comments (1)
README.md:19
- The
full comparisonlink uses#14-v1-v2-comparison, but the target heading is## 14. V1 vs V2 comparison, whose GitHub anchor includesvs. Clicking this link therefore does not navigate to the comparison section; use#14-v1-vs-v2-comparison.
V2 is more reliable, but not free: it uses roughly 2.9× more tokens and roughly 2.6× the illustrative cost per task. This project exists to make that trade-off measurable. Responses come from a simulated provider; every metric is computed by the harness ([full comparison](#14-v1-vs-v2-comparison)).
- Files reviewed: 4/5 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
Adds CI verification, improves README project presentation, and adds contribution guidance. The deterministic mock benchmark remains clearly labelled as a pipeline demonstration rather than production-LLM evidence.
CI uses Node.js 22: the installed toolchain declares Node >=22 (vitest 5 requires ^22.12.0, chalk 6 requires >=22), so
enginesand the README Node badge were updated to >=22.12 to match.