Skip to content

docs: clarify AI check limits and remove internal license note in README #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jongio merged 3 commits into from
Nov 5, 2026
Merged

docs: clarify AI check limits and remove internal license note in README #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dd1f2c9
docs: clarify AI check limits and remove internal license note in README
jongio Nov 5, 2026
05f8d8d
test: scope Outcomes and evidence README assertion to its section
jongio Nov 5, 2026
7078847
fix(test): anchor Outcomes and evidence section regex to end-of-string
jongio Nov 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,6 +305,7 @@ Lint success is `validated`, not an eval pass. A fully evidenced empty run with
exit zero warns and reports `not-run`: nonblocking but **not a pass**. Ambiguous
empty discovery with nonzero exit or missing JSONL remains an error. Ungraded
trials and weighted thresholds retain Vally's native semantics.
A passing check doesn't guarantee the AI will get it right every time.

| Output | Meaning |
| --- | --- |
Expand Down Expand Up @@ -437,9 +438,6 @@ Bundled dependencies are listed in
[`dist/bundled-dependencies.json`](dist/bundled-dependencies.json), with available
full terms in [`dist/THIRD-PARTY-NOTICES.txt`](dist/THIRD-PARTY-NOTICES.txt) and
retained inline notices in [`dist/index.cjs.LEGAL.txt`](dist/index.cjs.LEGAL.txt).
Entries marked `missing-license-text` still need authoritative terms and
release-owner clearance before public distribution; packaging checks do not
grant that clearance.

Use Node 24 and the pinned pnpm version. Run `pnpm check`, rebuild and commit
`dist/index.cjs`, and follow [CONTRIBUTING.md](CONTRIBUTING.md). Security reports
Expand Down
10 changes: 10 additions & 0 deletions tests/example.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,16 @@ describe('telemetry workflow contracts', () => {
});
});

describe('documentation content contracts', () => {
it('states in Outcomes and evidence that passing checks do not guarantee AI correctness and omits the internal license-clearance note', async () => {
const readme = await readFile('README.md', 'utf8');
const outcomesMatch = /\n## Outcomes and evidence\n([\s\S]*?)(?=\n## |$)/.exec(readme);
expect(outcomesMatch?.[1]).toContain("A passing check doesn't guarantee the AI will get it right every time.");
expect(readme).not.toContain('Entries marked `missing-license-text` still need authoritative terms');
expect(readme).not.toContain('release-owner clearance before public distribution');
});
});

describe('real Copilot example contract', () => {
it('documents separate jobs with one automatic reporter and no artifact wiring', async () => {
const readme = await readFile('README.md', 'utf8');
Expand Down
Loading