Skip to content

docs: add eval review guidance - #333

Merged
Rodriguespn merged 4 commits into
columferry/cli-2398-add-a-docker-less-local-stack-e2e-eval-agent-cli-lifecyclefrom
codex/docs-eval-review-guidance
Sep 28, 2026
Merged

Rodriguespn merged 4 commits into
columferry/cli-2398-add-a-docker-less-local-stack-e2e-eval-agent-cli-lifecyclefrom
codex/docs-eval-review-guidance

Conversation

@Rodriguespn

@Rodriguespn Rodriguespn commented Sep 24, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Source

@vercel

vercel Bot commented Sep 24, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Actions Updated
evals Ignored Ignored Preview Sep 28, 2026 9:40pm UTC

Request Review

Comment thread CONTRIBUTING.md
Co-authored-by: Rodriguespn <44656907+Rodriguespn@users.noreply.github.com>
@Rodriguespn
Rodriguespn marked this pull request as ready for review September 28, 2026 09:57
@Rodriguespn
Rodriguespn requested a review from a team as a code owner September 28, 2026 09:57
Comment thread CONTRIBUTING.md Outdated

Start with [Eval criteria](#eval-criteria) and [Writing prompts](#writing-prompts): confirm the `motivation:` cites a real user problem and the prompt has one clear, observable goal without leaking commands, schema details, or rubric language.

Then review [Writing scorers](#writing-scorers) assertion by assertion. Each check should map to a user requirement, avoid known false passes and false fails, measure behavior instead of one implementation path, and keep diagnostics as metrics rather than pass/fail gates. Ask for a deterministic or fixture-based check whenever it can replace `judge()`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I couldn't find a way to record a non-gating metric in apps/framework. As far as I can tell, a check either passes or fails, so nobody can actually follow "keep diagnostics as metrics" yet. Could you link to the mechanism, or reword it to something like "don't turn incidental diagnostics into pass/fail checks"?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I interpret it to mean that we keep the check but not have it gate the scenario's overall pass/fail, since there is a per-check pass/fail separate from per-scenario pass/fail. It isn't that useful in its current form though, eventually I think AI-1114 will offer a better strategy for diagnostic checks, so maybe the particular guidance here can wait on that.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch. I’ll replace the unsupported “metrics” wording with “don’t turn incidental diagnostics into pass/fail requirements.” We can revisit richer diagnostic checks under AI-1114.

Comment thread CONTRIBUTING.md Outdated

Use the [Submitting evals for review](#submitting-evals-for-review) workflow to require refreshed CI results before approval. The refreshed eval CI job should be green, which means the requested evals ran and results were recorded; it does not mean every agent passed the eval. After CI completes, inspect at least one passing result and each distinct failure shape, and confirm the experiment matches the intended suite, skills, runtime, hosted or local state, and any CLI or Docker assumptions.

Classify failing eval results before requesting changes: agent gap, product gap, scorer bug, or harness/runtime failure. A failing eval can be valid signal, but at least one known-bad solution or counterexample should fail to prove the scorer catches the intended failure mode.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This reads as a new approval requirement, but the guide doesn't say how to produce or show a counterexample. Only one eval has scorer tests today (evals/cli/build-database-002-stack-lifecycle/scoring.test.ts). Could you say how to show it, for example with a scorer unit test like that one or a failing run described in the PR? If not, maybe soften it to "ideally".

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would love to revisit AI-934 at some point, maybe a smaller version of this could add the new vitest scorers in parallel w/ existing smoke stuff so we can start migrating new stuff over to the newer system w/o legacy concerns.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. I’ll soften this to “ideally” and clarify that evidence can be a scorer unit test or a failing run linked or described in the PR. We can handle broader Vitest scorer migration separately under AI-934.

@Rodriguespn

Copy link
Copy Markdown
Contributor Author

Thanks both. I’ve updated the checklist so incidental diagnostics are not treated as pass/fail checks, and softened the counterexample guidance with a scorer unit test or linked failing run as examples.
I’ll merge this as the baseline guide. We can continue the diagnostic-check and scorer-testing work in follow-up PRs

@Rodriguespn
Rodriguespn merged commit a17a4d4 into columferry/cli-2398-add-a-docker-less-local-stack-e2e-eval-agent-cli-lifecycle Sep 28, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants