docs(packages): add README to core, graders, and reporter#128
Conversation
|
Warning Review limit reached
Next review available in: 49 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Only @a0/evals had a README; the other three published packages had none. npm auto-includes a package's own README in its tarball, so without these files the published packages ship with no documentation. Add a focused README to each describing its purpose, exports, and usage. @a0/evals already has a comprehensive README and is unchanged.
1e825b0 to
81923f0
Compare
What
Add a
README.mdto the three published packages that lack one:@a0/evals-core,@a0/evals-graders, and@a0/evals-reporter.@a0/evalsalready has a comprehensive README and is unchanged.Why
npm auto-includes a package's own
READMEin its tarball (it does not pull one from the monorepo root). Today only@a0/evalsships documentation; the other three would publish with none. Each new README describes the package's purpose, its main exports, and a short usage example, with links back to the monorepo for the full guide.Example snippets were checked against the actual exported signatures (
contains/judgein graders,renderHtml/loadScoresin reporter).Split out from the packaging cleanup so README and license/notice changes review independently.