Przejdź do treści
Biblioteka skilli
Programowanie · Pisanie

pg-create-upgrade-guide

/pg-create-upgrade-guide

Pisze przewodnik aktualizacji dla zmian łamiących zgodność w interfejsie CLI, formacie danych, konfiguracji lub pakiecie.

Licencja
MIT
Ostatnia zmiana repozytorium
09.11.2026

Ocena i bezpieczeństwo

100/ 100Klasa: dobry
Format25 / 25
Frontmatter z nazwą i opisem, poprawna nazwa, opis do 1024 znaków, nazwa zgodna z folderem.
Odkrywalność25 / 25
Opis mówi, kiedy użyć skilla, ma sensowną długość i jest w 3. osobie.
Treść35 / 35
Co najmniej 150 słów i do 500 linii, nagłówki, listy kroków, przykłady albo kod.
Higiena15 / 15
Bez zaślepek typu TODO, bez ścieżek Windows, z licencją.
Ryzykobrak sygnałów w skanie
Pliki w paczce
1
Skrypty
0
Komentarze HTML
0
Adresy URL w SKILL.md
0
Przestarzałość

Brak sygnałów. Repozytorium zmienione 09.11.2026, bez odwołań do wycofanych modeli i API.

Licencja

MIT, otwarta: można używać i zmieniać, z zachowaniem informacji o autorze.

Co robi i kiedy

Pisze przewodnik aktualizacji dla zmian łamiących zgodność w interfejsie CLI, formacie danych, konfiguracji lub pakiecie.

Oryginalny opis (EN)

Use when a change breaks an externally perceptible CLI, data format, configuration or stored data, or published package entry point, or changes a surface already covered by an unreleased upgrade guide.

Jak działa

  1. Scope
  2. Location
  3. Maintenance
  4. Format
  5. Verify
Sekcje z nagłówków SKILL.md, w oryginale · 49 linii, 485 słów
Podgląd SKILL.md
---
name: pg-create-upgrade-guide
description: Use when a change breaks an externally perceptible CLI, data format, configuration or stored data, or published package entry point, or changes a surface already covered by an unreleased upgrade guide.
---

# Create an upgrade guide

An upgrade guide tells a reader who runs release vT what to change to run the next release. Write it in the change that introduces the break, as soon as the break is recognized; do not defer it to release preparation.

## Scope

Write a guide only for breaks that someone outside the repository can observe after upgrading:

- application commands, flags, accepted values, or output paths;
- configuration or stored data that requires reader action to remain usable;
- published package names, entry points, exported functions, types, or accepted data fields.

Pre-stable internal APIs whose consumers are all updated in the same change need no guide. Keep the owning contract and any active decision record current; a guide states the reader's migration actions and links those owners rather than replacing them. Do not create a guide merely to populate this directory or describe the initial template import.

## Location

`docs/upgrade-guide/v<version>/<item>/guide.md`

- `<version>` is the `version` field of the root `package.json` when you write the guide, for example `v0.2.1-rc.2`. The guide describes the upgrade from that release to the next one.
- `<item>` is a kebab-case name of the changed surface, for example `output-flag-rename`.
- Each item directory holds exactly `guide.md`, its Chinese counterpart `guide.zh.md`, and the pairing record `guide.i18n.yaml`: no index, no attachments.

## Maintenance

While the root version is unchanged, the current version directory describes the delta from vT to the current development branch. When a later change touches a surface a guide there covers, update that guide in the same change; delete the guide when the break is reverted. After the version bump, guides in older version directories are frozen; a new break goes into the new version directory. Never write a guide spanning more than one release.

## Format

Start from the [upgrade-guide template](../pg-doc/templates/upgrade-guide.md). Write a one-sentence description naming what breaks. `verify-upgrade-guides` checks:

- frontmatter with exactly `kind: upgrade-guide` and a non-empty `description`; add a key only together with its check, then backfill every guide;
- one `#` title, then exactly the `## Change` and `## Migration` sections in `guide.md`, and `## 变更` and `## 迁移` in `guide.zh.md`, in that order;
- at most 500 words in `guide.md`, frontmatter included.

`Change` states the old and new behavior of the surface and who is affected. `Migration` lists ordered steps that name exact files, keys, commands, or symbols, and states how to confirm the migration worked.

When a guide needs more than 500 words, the extra text belongs elsewhere: link source files or symbols instead of restating code, move rationale into an [Agent Note](../../notes/README.md), and turn repeated mechanical steps into a script or generator command that the guide invokes.

Follow [pg-prose-standard](../pg-prose-standard/SKILL.md). Write the Chinese counterpart in the same change under the [bilingual pairing rules](../../../docs/AGENTS.md), then record the pair with `pnpm run verify-translation-pairing --write docs/upgrade-guide/v<version>/<item>/guide.md`.

## Verify

```sh
pnpm run verify-upgrade-guides
pnpm run verify-translation-pairing docs/upgrade-guide/v<version>/<item>/guide.md
pnpm run verify-md-links
```

Wersje

W bazie nie ma innych skilli o nazwie pg-create-upgrade-guide.

Migawka bazy z 13.11.2026 · wersja paczki b02654f78065 (skrót SHA-256 całej paczki)

Pobrania w ostatnich 30 dniach: 0 · ranking

Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.

Podobne skille

  • 100dsh-create-upgrade-guide
    Pisze przewodnik aktualizacji dla zmian łamiących powierzchnie DSH, takie jak CLI, ustawienia i dane użytkownika, zapisany w docs/upgrade-guide.
  • 100dsh-create-upgrade-guide
    Pisze lub aktualizuje przewodnik aktualizacji w docs/upgrade-guide, gdy zmiana w deepseek-harness łamie widoczną z zewnątrz powierzchnię: CLI, profile, klucze ustawień, dane użytkownika, API SDK lub punkty wejścia pakietów.
  • 90rspress-v2-upgrade
    Migruje projekty Rspress z wersji 1 do 2 według przewodnika, z aktualizacją konfiguracji i motywów oraz walidacją.
  • 100package-upgrade
    Analizuje aktualizacje pakietów npm, przestarzałe zależności i zmiany łamiące zgodność oraz przygotowuje etapowy plan aktualizacji.
  • 100package-upgrade
    Analizuje aktualizacje pakietów npm, przestarzałe zależności i zmiany łamiące zgodność oraz przygotowuje etapowy plan aktualizacji.
  • 100ss-upgrade
    Aktualizuje zależności i frameworki z analizą zmian niekompatybilnych, uruchamiając się przy zamiarze aktualizacji, migracji lub modernizacji.

Uwagi i zgłoszenia

Wiadomość trafi do Bartosza Sokolińskiego. Adres e-mail jest potrzebny tylko do odpowiedzi. Szczegóły w polityce prywatności.