docs: add sample quality and model E2E gates - #175
Draft
Tsuyoshi Ushio (TsuyoshiUshio) wants to merge 2 commits into
Draft
docs: add sample quality and model E2E gates#175Tsuyoshi Ushio (TsuyoshiUshio) wants to merge 2 commits into
Tsuyoshi Ushio (TsuyoshiUshio) wants to merge 2 commits into
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 853bf15f-8c6c-4aa6-9fcc-7c97a749d5b5
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.
Summary
This draft proposes explicit sample-design and sample-validation gates for medium and larger features. It separates that discussion from PR #174 so the ExecPlan proposal can be reviewed independently.
The goal is to prevent runnable samples from becoming overloaded system-test fixtures and to ensure that model-authored structured inputs are validated across the real model/runtime boundary.
Proposed changes
add-featureskill: identify the target learner, teach one primary capability, define a user-centered story and observable result, and explicitly decide whether to extend an existing sample or create a dedicated one.Motivation and examples
PR #170 is the motivating example. It exposed a gap only when a human ran the sample through the full natural-language → model → tool call → workflow path. PR #170 now proposes a concrete opt-in harness at
samples/workflow-retry-policy/scripts/run-e2e.py, including Skill-resource loading, safelocal.settings.jsoncreation, real Foundry execution, terminal-status checks, and ownership-safe cleanup.This process PR does not depend on PR #170 merging. Its requirements are intentionally generic and apply beyond workflows. The exact guidance can be refined after #170 merges and the concrete harness receives review.
PR #174 remains focused only on whether to adopt ExecPlans.
Opt-in behavior
The live E2E runs only when all sample-specific Foundry variables are present. With none present, it skips clearly. Partial configuration fails with an actionable message. A sample-owned script may generate ignored local settings only if it can prove ownership, must not overwrite existing or concurrently created files, and must remove only resources it created.
Feedback requested