Repository navigation
docs: clarify AI check limits and remove internal license note in README - #21
Conversation
Closes github/evals-internal#514 Closes github/evals-internal#515 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
🟡 Changes recommended
An active nit remains in tests/example.test.ts because the assertion does not scope the required sentence check to the ## Outcomes and evidence section.
1 open issue
What changed in this PR
This documentation-only pull request clarifies the limits of AI checks, removes internal license-clearance guidance from the user-facing README, and adds regression coverage for both documentation requirements.
Changes:
- Adds an AI-correctness limitation to the Outcomes and evidence section.
- Removes internal
missing-license-textrelease-clearance guidance from Development and acquisition. - Adds README contract assertions in
tests/example.test.ts.
| File | Summary | Review notes |
|---|---|---|
README.md |
Updates user-facing outcome and licensing documentation. | No findings. |
tests/example.test.ts |
Adds regression assertions for the README documentation invariants. | Nit: Scope the assertion to the Outcomes and evidence section so it verifies the sentence remains in the required section. |
Review effort: Lite (auto)
There was a problem hiding this comment.
Docs change looks correct and CI passes. One low-severity item remains before approval: the new test only checks that the sentence appears anywhere in the README, not in the "Outcomes and evidence" section. This is already raised in an existing thread, so I did not open a duplicate: #21 (comment)
Reviewed commit dd1f2c9. No code was run locally; I relied on the passing CI checks.
Generated by 🌳Breza Bot
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
|
Addressed reviews
|
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
wbreza
left a comment
There was a problem hiding this comment.
Approved. The earlier low item is fixed: the test now looks only inside the "Outcomes and evidence" section for the new sentence, so moving it elsewhere would fail the test. The docs changes are correct. Unit tests, lint, type check, bundle check and smoke test pass on commit 7078847. Two CodeQL analysis jobs were still pending when I reviewed; I did not run anything locally.
Generated by 🌳Breza Bot
There was a problem hiding this comment.
🟢 Approval recommended
The narrowly scoped documentation updates include regression assertions covering the required warning, removal, and section placement, with no active review issues identified.
No open issues 🎉
1 resolved since last review
Review effort: Lite (auto)

Summary
Closes github/evals-internal#514
Closes github/evals-internal#515
"A passing check doesn't guarantee the AI will get it right every time."in the## Outcomes and evidencesection ofREADME.md(github/evals-internal#514).missing-license-textfrom the user-facing## Development and acquisitionsection ofREADME.md(github/evals-internal#515), while preserving the maintainer guidance inCONTRIBUTING.md.tests/example.test.tsverifying bothREADME.mddocumentation invariants.Verification
pnpm typecheck(tsc --noEmit): passedpnpm lint(oxlint --deny-warnings src tests): passedpnpm test:coverage(vitest run --coverage): passed (10 test files, 177 tests passed)pnpm check:dist(node tooling/build.mjs --check): passedpnpm test:packaged(node --test tooling/packaged.test.mjs): passed (6/6 tests passed)distmatch source.Limitations
None. Documentation and unit test update only; runtime bundle (
dist/index.cjs) is unchanged.