vercel/board

pr-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.

Quelltext ansehen

Verwendung

  1. Installationsbefehl kopieren und das Quellpaket vor der Installation in der eigenen Agentenumgebung prüfen.
  2. Benötigte Werkzeuge, Zugangsdaten und Hosts im Original prüfen.
  3. Eingabe und gewünschtes Ergebnis beschreiben und die Ausgabe mit den Quellen abgleichen.
npx skills add https://github.com/vercel/board --skill pr-description

Vor dem Start

  • Die Installation umfasst weder Modellabo noch API-Kontingent oder Dateizugriffsrechte.
  • Sterne und Installationen zeigen Aktivität, keine unabhängige Qualitäts- oder Sicherheitsprüfung.
Originales Skill-Dokument

Aus dem Quell-Repository gerendert; Überschriften, Beispiele, Code, Tabellen, Links und Bilder bleiben erhalten.

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

$ 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.`

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

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.
aus demselben Repository

Weitere Skills

Alle Skills