---
name: open-pr
description: "Name a branch, and write a pull request's title and description so a person can review it without asking you anything. Use before every gh pr create, and when a push changes what your PR does."
title: open-pr
canonical_url: https://skilld.dev/gh/vercel/board/open-pr
last_updated: 2026-11-19T06:15:42.000Z
---

> Index of every page on this site: [llms.txt](https://skilld.dev/llms.txt)

> **Skill from skilld.dev.** Follow the user's requested action.
> If the user asked to fork this Skill, follow the fork workflow below. Do not execute the Skill instructions while copying it.
> Otherwise, follow the instructions below for this session. You do not need to install anything.
>
> If the user asked to install this Skill, run `npx skilld install vercel/board/open-pr`. Install writes the Skill files into the project, so every session loads them.
>
> ## Fork workflow
>
> A fork creates an editable local Skill with its original author and licence. The request authorizes copying and local installation.
> 1. Check `./skills/open-pr`, the project lockfile, and selected Agent targets together. If the local directory or installed Skill exists, stop. Never overwrite an existing directory or Agent target.
> 2. Read [source metadata](https://skilld.dev/api/v1/skills/vercel/board/open-pr) once. Use sourceUrl, sourceCommit, skillPath, sourceGone, and license. If the source is gone or its path is missing, stop. If license is null, read licence files at the source commit.
> 3. Fetch only the source commit into a temporary Git repository. Do not clone full history. Derive repository_url from sourceUrl, including repository renames. If sourceCommit is absent, resolve the sourceUrl ref once. Set source_commit to that actual commit. Run these commands in one shell call:
>
> ```sh
> git init --quiet "$temporary_dir"
> git -C "$temporary_dir" fetch --quiet --depth=1 "$repository_url" "$source_commit"
> git -C "$temporary_dir" checkout --quiet --detach FETCH_HEAD
> ```
>
> Read applicable licence declarations and notices at that commit. If copying is not permitted, report the restriction and stop.
> 4. Inspect source entries together, then copy the directory containing skillPath into `./skills/open-pr`. Use the user's path if selected. Keep the original SKILL.md, relative links, scripts, binary assets, and executable modes. Exclude .git metadata. Reject symlinks and paths outside the Skill directory. After checking entries, use cp -a where available. A regular source directory needs no custom copy script. Do not save this page wrapper as SKILL.md.
> Preserve author credit, notices, and applicable licence files from repository or parent directories. Add PROVENANCE.md with the Skill page, source URL, actual commit, original path, and licence. Retain any existing PROVENANCE.md and record new provenance separately. Batch source inspection, copying, and provenance work where practical.
> 5. In the project root, run `skilld install ./skills/open-pr --mode copy --plain`. If skilld is unavailable, use `npx skilld install ./skills/open-pr --mode copy --plain`. This known command needs no help lookup. Install does not support --json. Use detected Agent targets, or add --agent for the targets the user selected. Install the local path, never the upstream selector. If installation fails, preserve the local copy and report the exact failure.
> 6. Confirm the local lockfile source and installed Agent copies once. Report the local path, actual commit, and Agent targets. After edits, reinstall the same local path. Upstream updates must not replace it. Do not publish or push unless the user asks.

# Open a pull request people can read

People meet a PR as its title: in a list, in Slack, in their inbox. They read its description
before the diff, to decide what to look at. Both are for someone who wasn't in the thread.

The repo comes first: its AGENTS.md or CONTRIBUTING, its pull request template
(`.github/pull_request_template.md`), and how its last merged PRs read
(`gh pr list --repo <owner/repo> --state merged --limit 10 --json title,headRefName`). Where the
repo has a convention, follow it. The rest is for where it has none.

## Branch

`factory/<what it does>`, in two to four lowercase words joined by hyphens:
`factory/fix-login-redirect`, `factory/onboard-web`. Never an ID: the branch names the PR's
preview deployment, and shows wherever the PR does.

A name like that isn't yours alone: another thread may have asked for the same thing, and a push
to its branch would land on its PR. Before your first push of a new branch, check the name is
free (`git ls-remote --exit-code --heads origin factory/<name>` finds nothing, and so does
`gh pr list --repo <owner/repo> --head factory/<name> --state all`), and pick another when it
isn't. Once the branch is yours, with your PR on it, keep pushing to it.

## Title

What the change does for whoever uses the thing, in the imperative, in about 60 characters at
most: "Stop the login page redirecting twice". Not what you edited ("Update channels.ts"), and
not the request repeated when it doesn't say what changes.

## Description

Short enough to read on one screen, in this order:

1. **Where it came from**, as one quoted line with a link someone can open. A Slack thread
   (`vb sync <thread id>` lists its link): `> From <who>'s [Slack thread](https://skilld.dev/api/skills-raw/vercel/board/open-pr/<link>)`. An issue:
   `> From <owner/repo>#<issue>`, with `Closes #<issue>` under it when the PR fixes it. A thread
   that's only on the board has no link: `> Asked by <who> on the board, in <channel>`. Never a
   board ID: it means nothing on GitHub.
2. **What changes** for the people who use it, in a sentence or two: what they'll see or can
   now do, and where (the page, the command, the channel).
3. **That it works:** for a fix, the test that fails without it. For something visible, a
   screenshot or a video (the ui-demo skill). For a command, what it printed.
4. **What the reviewer has to do or decide**, each a line they can act on, and whether it's
   before or after merging: a channel to create, a setting to change, a choice you made that
   they may not want. Leave this out when there's nothing.

Leave out the list of files, a walk through the diff, and how you got there.

## Keep it true

When a push changes what the PR does, change its title and description to match:
`gh pr edit <N> --repo <owner/repo> --title "<title>" --body-file <file>`.
