nexu-io/open-design

writing-guidelines

Review docs/prose for Writing Guidelines compliance.

Zobacz źródło

Jak używać

  1. Skopiuj polecenie instalacji i sprawdź źródła przed instalacją we własnym środowisku agenta.
  2. W oryginale sprawdź wymagane narzędzia, dane dostępowe i obsługiwane środowiska.
  3. Opisz dane wejściowe i oczekiwany rezultat; porównaj wynik ze źródłami.
npx skills add https://github.com/nexu-io/open-design --skill writing-guidelines

Przed rozpoczęciem

  • Instalacja nie obejmuje subskrypcji modelu, limitu API ani uprawnień do plików.
  • Gwiazdki i instalacje pokazują aktywność, a nie niezależny test jakości lub bezpieczeństwa.
Oryginalny dokument Skill

Treść z repozytorium z zachowaniem nagłówków, przykładów, kodu, tabel, linków i obrazów.

Writing Guidelines

Review files for compliance with Writing Guidelines.

How It Works

  1. Load the pinned guidelines from `references/guidelines.md` — this is the default, reproducible execution path
  2. Optionally, fetch the latest guidelines from the upstream URL below and diff against the pinned snapshot to see if anything has changed
  3. Read the specified files (or prompt user for files/pattern)
  4. Check against all rules in the guidelines
  5. Output findings in the terse file:line format

Guidelines Source

Default (pinned): The vendored copy at `references/guidelines.md` is the default execution path. It is a pinned snapshot of the upstream guidelines and guarantees the skill produces reproducible results in any runtime environment.

Upstream (live): For users who want the very latest rules, the live source is available at:

https://raw.githubusercontent.com/vercel-labs/writing-guidelines/main/command.md

Fetching the live version is optional — the pinned snapshot is always the baseline.

Usage

When a user provides a file or pattern argument:

  1. Load `references/guidelines.md` as the default source
  2. Optionally fetch the upstream URL to check for updates
  3. Read the specified files
  4. Apply all rules from the guidelines
  5. Output findings using the format specified in the guidelines

If no files specified, ask the user which files to review.

Powiązane zadania

z tego samego repozytorium

Więcej Skills

Wszystkie Skills