Skip to content

PR template: ask for code examples, and something reviewers can try - #75

Merged
brentvatne merged 2 commits into
mainfrom
@brent/pr-template-examples
Oct 24, 2026
Merged

brentvatne merged 2 commits into
mainfrom
@brent/pr-template-examples

Conversation

@brentvatne

@brentvatne brentvatne commented Oct 24, 2026 •

Copy link
Copy Markdown
Member

What and why

The template asked for screenshots, but nothing showed a change to how Explore is used. A new section, Code examples, asks for that. It covers changes to:

  • a CLI command or flag;
  • config.yaml;
  • a workflow template;
  • a file format, such as a replay or flows file, or report JSON;
  • a public type.

The example shows the change in use as a reader would write it: the command, the file it reads, and what it prints or writes. When existing usage changes, it shows that usage before and after. If nothing about usage changes, the author writes "No change to usage".

A second new section, Try it, is optional but recommended: something a reviewer can open or run to see the change. It points at:

  • the Viewer preview this repository already deploys for each pull request, for a Viewer change;
  • a hosted report from a run of the branch, or an app pull request whose review ran it, for a change to capture or reports;
  • otherwise, the commands that run it from a checkout of the branch.

The Screenshots section is unchanged.

Screenshots

No visible change.

Code examples

The new section, as it appears in the template:

## Code examples

<!--
Required for any change to how Explore is used or what it writes: a CLI command or flag,
config.yaml, a workflow template, a file format (a replay or flows file, report JSON), or a
public type. Show it in use as a reader would write it: the command with its flags, the config
or file it reads, and what it prints or writes, trimmed to the lines that matter. When existing
usage changes, show it before and after.
Write "No change to usage" if there is none.
-->

```sh

```

The Try it section:

## Try it

<!--
Optional, but recommended: something a reviewer can open or run to see the change for themselves.
- A Viewer change: the Viewer preview comment on this PR links a live build. Name the report,
  screen and steps to look at.
- A capture or report change: a hosted report from a run of this branch (explore:binary,
  explore:session or capture with --upload), or an app pull request whose review ran this branch.
- Otherwise: the commands that run it from a checkout of this branch, for example
  `npm ci && npm run build`, then `node dist/cli.js <command>`, with any app or file it needs.
Write "Nothing to try" if there is nothing a reviewer could run.
-->

Try it

Nothing to try: the change is the template itself, which shows up on the next pull request opened after it merges.

Testing

Markdown only: no code or tests change. I haven't opened a pull request from the new template to see it rendered.

🤖 Generated with Claude Code

@brentvatne brentvatne changed the title PR template: ask for code examples of any change to how Explore is used or what it writes PR template: ask for code examples, and something reviewers can try Oct 24, 2026
@github-actions

github-actions Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

This preview was deleted on 2026-10-31, a week after the pull request closed. The links below no longer open.

Viewer preview of 4ae0077 · reports from brentvatne/euxy#163

Report Changes Open
Android · sdk_gphone64_x86_64 15.0 5 Map · Screens · Compare
iPhone 17 · iPhone 17 26.5 · light + dark 11 Map · Screens · Compare
iPhone Duo (closed) · iPhone Duo 27.1 · light + dark 34 Map · Screens · Compare
iPhone Duo (open) · iPhone Duo 27.1 · light + dark 34 Map · Screens · Compare

The link stays the same on every push. Deploy run

@brentvatne
brentvatne merged commit 7fa07d2 into main Oct 24, 2026
16 checks passed
@brentvatne
brentvatne deleted the @brent/pr-template-examples branch October 24, 2026 04:58
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.

1 participant