agentleFS
6SNT-RADIO6SNT-RADIO/6SNT-Studio/skills/smoke-test/SKILL.md

smoke-test

Skill0 starsChanged 5 months agoMITView on GitHub

'Done' includes an artifact that STARTS: an automated headless smoke with ONE command, pass/fail by exit code, and tests/smoke-result.json for the release-gate DoD. Use it to author/run the smoke (08 QA) on any stack.

21 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use debugging-difficult-bugs, pr-explainer and 1 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • dzevsSkill

    debugging-difficult-bugs

    Use early when debugging a medium or hard bug, especially when tests alone may not reveal the real runtime failure. Trigger this before extended TDD iteration when a bug involves runtime state, PTY/terminal ordering, persistence, streaming, async/concurrency, the TUI/manual reproduction, the IPC socket layer, or when a red or newly passing test may not model the real issue. Skip only when the root cause is already directly proven by a stack trace or deterministic test that exercises the real runtime path.

    Also in 3 projects that use this

  • Mathews-TomSkill

    pr-explainer

    Use when a developer asks to explain a pushed PR, walk through a PR stack, understand one stack member, or explain what an AI agent just pushed so they can connect code changes to end-to-end functionality and update domain knowledge. Not for defect review, merge approval, PR-body authoring, or full-repository onboarding.

    Also in 3 projects that use this

  • dzevsSkill

    pr-splitter

    Use when breaking a large, complex, messy, or hard-to-review pull request into multiple smaller PRs; planning stacked PRs; extracting independent changes from a branch; splitting mixed refactor and behavior changes; managing drift after review feedback (operator gate, Codex/swarm second opinion); rebasing follow-up PRs as earlier PRs change; or preserving original branch intent while shipping incrementally.

    Also in 3 projects that use this

The file

We split this skill into the rules it gives an agent

2 rules. 0 are common, 0 are distinctive, and 2 are very specific to this project.

  • 0

    Common

    Most of the 18 edited versions we read keep these.

  • 0

    Distinctive

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    CLI: run the binary (--version/--help or a no-op) → exit 0 + expected output + smoke-result.json.

    line 38
  2. Very specific:

    Service/API: start + health-check (e.g.

    line 39

“Common” is measured: kept by at least 6 in 10 of the 18 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

SKILL: smoke-test — "done" includes that it STARTS (automated smoke)

Principle (P-10 · any stack/domain). "Done" is not just that it compiles and unit tests pass: it includes an artifact that STARTS, proven by an automated smoke with a clear pass/fail. The studio AUTHORS the smoke; the PO/CI runs it with ONE command. Applies to any domain and any stack (desktop, web, CLI, service): the smoke confirms the binary/process boots and shows/exposes the essentials.

Why it exists: headless QA and unit tests do NOT catch startup/integration failures of the packaged artifact (init order, production paths, bundle load, handler registration). An automated smoke does — and it runs with no human watching.

What it tests (and what it does NOT)

  • YES: the artifact STARTS + renders/exposes the ESSENTIALS (window/root + 2-3 key points).
  • NO: business logic — that's unit tests. Nor exhaustive coverage. The smoke is about STARTUP.
  • P-11: whatever can't be validated without a real environment (hardware, live data, network) is DECLARED deferred, not faked.

Contract (invariant, any stack)

  • ONE command (smoke script) → exit 0 = pass / exit 1 = fail. CI-ready.
  • Machine-readable evidence: on finish it writes tests/smoke-result.json = { "pass": true|false, "ts": <epoch>, "screenshot": "tests/smoke.png" }. The RELEASE gate verifies it mechanically (DoD): without a recent smoke-result.json with pass:true, release does NOT close.
  • Also leave the startup screenshot (PNG).
  • Headless / no display (no human intervention required).

Current recipe — Electron (the current one, NOT the only one)

@playwright/test with _electron.launch:

  1. const app = await electron.launch({ args: ['.'] }) → starts the Electron project.
  2. const win = await app.firstWindow() → the main window opens (if not, FAIL).
  3. Assert 2-3 key data-testid elements visible (root + main views; placed by 06 FRONTEND).
  4. await win.screenshot({ path: 'tests/smoke.png' }) → visual evidence.
  5. Write tests/smoke-result.json { pass, ts: Date.now(), screenshot: 'tests/smoke.png' } (in finally, so a failure also leaves pass:false). await app.close(). Pass/fail via the runner's exit code.
  • Single script: "smoke": "playwright test tests/smoke.spec.ts". DevDep: @playwright/test.
  • CI without display: on Linux wrap with xvfb-run; on Windows it starts directly.

Other stacks (same principle, different recipe)

  • Web: Playwright/Chromium headless → the page loads + key selectors + screenshot + smoke-result.json.
  • CLI: run the binary (--version/--help or a no-op) → exit 0 + expected output + smoke-result.json.
  • Service/API: start + health-check (e.g. /health 200) → exit 0 + smoke-result.json. The studio picks the recipe by stack; the contract (one command · pass/fail · smoke-result.json · evidence · startup-not-logic) is identical.

Who

  • 08 QA AUTHORS the smoke and leaves it running pass/fail; attaches the screenshot to QA_REPORT.md and leaves tests/smoke-result.json for the release-gate DoD.
  • 06 FRONTEND places the data-testid on the key elements (root + main views) the smoke needs.
  • 04/07 wire the smoke script (ONE command) into the project's scripts/build.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.