Index of every page on this site: llms.txt
All skills
vercel avatar

/pr-description

@86694bd
by vercelvercel/board147 stars
13
Run it yourself

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.

Use this Skill: https://skilld.dev/gh/vercel/board/pr-description

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈57 tokens for metadata: the name and description. ≈811 when used: this file.

Description uses 2.8% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈227 characters, or 2.8%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

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

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.

Source: SKILL.md on GitHub

No rule matched.

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

1 warning2d3 checks · Risk SAFE
  • Gen Agent Trust Hub2d

    This skill is safe and provides structured guidelines for generating Pull Request (PR) titles and descriptions. It establishes standard formatting for evidence and examples for project contributors.

  • Socket2d

    No alerts

  • Snyk2d

    Risk: MEDIUM · 1 issue

Signed by skilld at 86694bd. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 12 hours ago.

Activeupdated 2 weeks ago

README badge

README badge for vercel/board/pr-description