Start free
Templates · Pr Walkthrough

PR walkthrough template.

For PRs that need more than a one-line description. The author records a short walkthrough; the template captures what the recording does not.

The template

### What this PR does
[One paragraph for the reviewer who hasn't seen the design doc]

### Why now
[Trigger / linked issue]

### Tour of the diff (matches the recording)
- src/foo.ts — extracted helper
- src/bar.ts — new endpoint
- tests/baz.test.ts — coverage for the edge case

### What I want a careful look at
- [Specific file or function]
- [Specific edge case]

### What I am NOT asking for here
- [Refactor opportunities I am deferring]

### How to test locally
```
pnpm install
pnpm test --filter foo
```

### Recording
- Author walkthrough: <link>

Frequently asked

Does it replace the PR description?

It replaces the cargo-cult PR description. The recording carries the visual tour; the text carries the things hard to point at.

Try Screendog free.

5 recordings on the free trial. Real Linear, GitHub, Notion, Slack, and Jira filing. No credit card.

Start a workspace — free