---
name: pr-description
description: Write a board pull request's title and description as AGENTS.md's "pr titles and descriptions" asks, with the evidence to show it working. Use whenever you open a PR in this repo or rewrite one's title or body.
title: pr-description
canonical_url: https://skilld.dev/gh/vercel/board/pr-description
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/pr-description`. 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/pr-description`, 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/pr-description) 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/pr-description`. 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/pr-description --mode copy --plain`. If skilld is unavailable, use `npx skilld install ./skills/pr-description --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.

# Write a PR's title and description

Follow "pr titles and descriptions" in AGENTS.md: the title, the four answers
(Users, Protocol / backends, Performance / I/O, Tests), and the rules after
them. This says how to get the evidence here.

## Evidence

- **CLI and output changes:** run the commands on a real board (`vb serve` in
  a scratch directory, or the verify-board skill) and paste what printed in a
  `text` block with the command line. Trim it; don't retype it. For a bug, the
  wrong output on `main`, then the right one on the branch.
- **UI changes** (the inspector, the docs site, Slack or GitHub rendering): a
  screenshot, or a short video for a flow. Add it to the PR on github.com, or
  attach it to the PR's board thread (`vb reply <root id> --attach <file>`) and
  say where it is.
- **What can't be shown** (a race, a refactor, a bump): the test that fails
  without the change, or the check you ran, in one line.
- **What a test fakes:** a platform's API (Slack, GitHub) is fine to fake, and
  the Tests line says so. A test that mocks board's own code tests the mock.
- **SDK samples:** copy the imports from the file the sample came from (the
  factory's `route.ts`, a test), every `@vercel/board/*` one, so the sample shows
  where each name lives.

## Example

Title: `feat(sync)!: resolve platform links and list a thread's copies`

````markdown
Go between a board message and its copies on Slack and GitHub.

- **Users:** `vb sync <id>` lists where a thread is synced; `vb read <link>` reads the thread a Slack or GitHub link names.
- **Protocol / backends:** breaking for custom backends: 2 new methods, `synced` and `linked`. The conformance kit's `sync` group checks both.
- **Performance / I/O:** `vb sync`: 3 board reads, plus 1 `chat.getPermalink` per Slack copy. `vb read <link>`: 1 lookup per sync entry of the link's platform, then the thread; no platform calls.
- **Tests:** the CLI as a subprocess against a board over HTTP, in-process boards on `local()` and `http()`, and the conformance kit. Slack's and GitHub's APIs are faked; nothing of board's is.

### Users

```text
$ vb sync 2
slack  C1:1727000000.123456  https://acme.slack.com/archives/C1/p1727000000123456

$ vb read https://acme.slack.com/archives/C1/p1727000000123456
#2  U_ADA · 0s
      checkout is down
```

A link the board didn't sync and one in a channel you can't read get the same
`error: Couldn't find that link's message on this board.`

```ts
import { board } from '@vercel/board'

const team = board()
await team.sync(id)     // { targets: [{ target, key, thread, message, url, undelivered }] }
await team.linked(url)  // the thread, as team.thread(id) answers it
```

### Protocol / backends

```ts
synced  GET /messages/:id/sync → SyncedView  // from sync's records
linked  GET /links?url=        → ThreadView  // never asks the platform

// SyncProvider, both optional, by the platform's own IDs:
locate(url): { thread, message | null } | null
url(thread, message): Promise<string | null>
```

- Custom backends implement `synced` and `linked`; `ChatSyncProvider` subclasses rename the protected `locate()` to `locationOf()`.

### Open

- A board without a provider for a platform can't read that platform's links.
````
