Files
gstack/qa/templates/functional-report-template.md
T
garrytan 8dd3c44fc6 fix(qa): checkpoint receipts print the report link for their exploration file
qa-functional-webhook-report failed in two of three censuses because the
report linked .qa-evidence/NNN capture folders as "checkpoints" and never
linked exploration-NNN.json. The checkpoint receipt now prints
link: [checkpoint NNN](exploration-NNN.json), and the functional report
template says capture folders are not checkpoints.
2026-09-29 21:49:46 +00:00

3.1 KiB

Functional QA Report: {TARGET}

Field Value
Date / branch / revision {DATE / BRANCH / COMMIT AND WORKING-TREE INPUTS}
Caller / authority / depth {qa-only, qa, review or ship; permitted writes; bound}
Surfaces / scope {API, CLI, job, worker, webhook; changed and adjacent contracts}
Runtime / native tools {VERSIONS AND REPOSITORY-SUPPORTED COMMANDS}
Fixture ownership / destinations {ISOLATED ROOT, STORES, DOWNSTREAM TARGETS}
Duration / stop reason {MEASURED DURATION, COMPLETE OR BOUND/BLOCKER}

Contract outcomes

Contract and source Exact probe / evidence Expected → observed Outcome
{CONTRACT, DOC/TEST/USER SOURCE} {COMMAND OR REQUEST, EVIDENCE PATH} {OUTPUT AND DURABLE EFFECT} pass / fail / blocked / not run / inconclusive / not applicable (reason)

No visual score applies to this functional section. In a mixed report, keep the browser section's score and evidence separate, and link both surfaces' replay evidence and regression baselines. Do not combine their scores or outcomes.

Findings

ISSUE-NNN: {Reproduced defect or setup blocker}

  • Classification / severity: {PRODUCT DEFECT / SETUP / INCONCLUSIVE; IMPACT}.
  • Intended contract and source: {EXPECTED BEHAVIOR, NOT MERELY CURRENT IMPLEMENTATION}.
  • Reproduction: {WORKING DIRECTORY; SAFE SETUP/RESET; ENVIRONMENT NAMES ONLY; EXACT COMMAND OR METHOD/PATH/HEADERS/BODY USING SYNTHETIC VALUES}.
  • Observed: {EXIT/STATUS; STDOUT; STDERR; INITIAL/FINAL DURABLE STATE; REPLAY/RETRY ORDER}.
  • Evidence: {EXACT SAFE OUTPUT AND STATE PATHS; REVISION/RUNTIME; REDACTION AND REPRODUCIBILITY LIMITS}.
  • Diagnosis / next action: {CAUSAL EVIDENCE OR SPECIFIC PREREQUISITE; NO SPECULATIVE FIX}.

Discoveries and permanent tests

Link each exploration-NNN.json checkpoint, saved before its next probe, in this report. Each checkpoint receipt prints its link; .qa-evidence/NNN capture folders are not checkpoints. Use one Markdown entry per checkpoint, for example:

Use the actual filename and a path relative to this report (or its owned absolute path); plain or backticked filenames are not links. Include superseded checkpoints as history, not current passing evidence. Keep these original notes with the report.

Hypothesis / discovery Native test or proposed case Red evidence before repair Green + original + adjacent evidence Parent disposition
{OBSERVATION THAT CHANGED THE NEXT PROBE} {UNIT / INTEGRATION / E2E; PATH OR REPORT-ONLY PROPOSAL} {EXACT DEFECT FAILURE OR HEALTHY CONTRACT} {ACTUAL RESULTS OR NOT RUN} {AUTHORIZED CHANGE / SUGGESTION / DEFERRED}

Coverage limits and cleanup

List unexecuted charters, unavailable prerequisites, denied effects, ambiguous contracts, incomplete observations and remaining risk. Do not count them as passes. Name owned processes/state cleaned and anything left behind. State whether later changes invalidated evidence. Report-only must identify proposals separately from tests actually created.