Skip to content

Tutorial share step: before/after screenshots and a polished PR body #3362

Closed

Description

@janicduplessis

Problem

The tutorial's optional share step (stim guide tutorial share) produces a thin pull request: gh pr create --fill builds the body from the commit, and it attaches one screenshot of the result. The reader sees no before state, no device, and nothing about how Stim verified the change. The goal is a pull request the user is pleased with: a one-line summary, a before/after table of the same screen on the same device, a "How it was verified" section (device and runtime, app readiness, build time and cache hit, stim logs --errors), and a Stim link.

appandflow/stim-tutorial#2 adds a matching .github/pull_request_template.md and an AGENTS.md that routes agents to stim guide tutorial, so the substance belongs in the version-matched guide.

Evidence

  • stim guide tutorial share on origin/main: --fill, a single finish.png, and a fallback that commits the PNG and links it relatively (![the change](finish/<github-login>.png)), which does not render in a pull request body.
  • Dry run with stim 1.19.0 and gh 2.99.0: before/after captured with agent-device screenshot in one worktree (before the edit, then after Fast Refresh), and gh pr create --body-file body.md --attach screenshots/before.png --attach screenshots/after.png rewrote the ./screenshots/*.png references inside the table to user-attachments URLs without appending duplicates (docs: agent instructions and a before/after PR template stim-tutorial#2).
  • Facts for the verified section: stim status --json -> ios.name, lastBuilds.ios.durationMs, lastBuilds.ios.cacheHit; readiness from the readiness app reported ready line of stim ios.

Cause

The share step predates the template and was written for a single proof image.

Fix idea

In stim guide tutorial: tell the agent to capture a before screenshot of each change before editing, then an after once Fast Refresh applies; rewrite the share step to write the body from the repo template and attach both images with --attach; update the manual share commands. Touch only the screenshot and PR parts.

Activity

  1. janicduplessis commented on Oct 10, 2026

    @janicduplessis
    CollaboratorAuthor

    Claimed: docs/3362-tutorial-share-pr

  2. added
    type: featureAdds or changes behavior, including performance and polish
    priority: P2Normal; default when unsure
    area: clipackages/stim-cli, including its README and guide
    on Oct 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: clipackages/stim-cli, including its README and guidearea: websitewebsite/priority: P2Normal; default when unsuretype: featureAdds or changes behavior, including performance and polish

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions