Przejdź do treści
Biblioteka skilli
Programowanie · Pisanie

pr-description

/pr-description

Pisze opis pull requesta, z którym opiekun nie musi zadawać pytań: co się zmieniło, dlaczego, jak to przetestowano i od czego zacząć czytanie.

Licencja
MIT
Ostatnia zmiana repozytorium
12.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 12.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 opis pull requesta, z którym opiekun nie musi zadawać pytań: co się zmieniło, dlaczego, jak to przetestowano i od czego zacząć czytanie.

Oryginalny opis (EN)

Write a pull request description a maintainer can act on without asking a single clarifying question. Use when opening any pull request. Covers what changed, why, how it was tested with fail-first evidence, and the most skipped element of all: an explicit statement of what feedback is wanted and where to start reading.

Jak działa

  1. The template
  2. Before you request review
  3. Anti-patterns
  4. Close-out
Sekcje z nagłówków SKILL.md, w oryginale · 43 linii, 527 słów
Podgląd SKILL.md
---
name: pr-description
description: Write a pull request description a maintainer can act on without asking a single clarifying question. Use when opening any pull request. Covers what changed, why, how it was tested with fail-first evidence, and the most skipped element of all: an explicit statement of what feedback is wanted and where to start reading.
---

# PR Description

A description is the reviewer's interface to your change. In large samples of real pull requests, most descriptions state a purpose and stop. The element that separates merged from abandoned, more strongly than any other in the description itself, is the one almost nobody writes: an explicit statement of what feedback you want. Write it every time.

Run this when opening the PR, after fail-first-testing has produced its evidence.

## The template

Fill the project's own PR template completely first; this structure fills its gaps, never replaces it.

**What and why.** Two or three sentences. What this changes, and the problem it answers, with the issue linked (`Fixes #123` where the project uses closing keywords). Breaking changes go here, at the top, in plain words, never buried.

**How.** The approach in a few lines: the mechanism, the files that matter, anything you chose between two plausible designs and why. Not a file-by-file narration; the diff already says what. This says why it looks like that.

**How it was tested.** The commands you actually ran and what they returned. For a bug fix, the fail-first evidence: the regression test failing before, with output, and passing after. For performance, the before and after numbers with the commands to reproduce them. For UI work, before and after screenshots. Never write "tested locally" and stop.

**What feedback I want.** Say it directly:

- The specific questions you want answered ("Is capping at the config value the right layer, or should the caller own this?").
- Where to start reading ("Start at `retry.py`; the rest is the test and one call site").
- What can be skimmed or skipped ("The fixture file is generated; no need to read it line by line").
- What you are unsure about. Naming your own uncertainty invites exactly the review that helps.

**Known limits and non-goals.** What this deliberately does not do, matching the non-goals agreed in issue-first. A reviewer who finds a boundary you already declared reads it as discipline; one who finds an undeclared boundary reads it as a miss.

## Before you request review

1. **Self-review the full diff**, as if it were a stranger's. You will catch something; everyone does.
2. **CI green.** Every failed check sitting on the PR when review starts measurably cuts the chance of a merge; run locally what CI will run, and never use a maintainer's review round as your test suite.
3. **One purpose check.** Diff stat matches what small-diff promised. If it grew, say why in the description or split.

## Anti-patterns

- "Fixes the bug" as the entire description.
- A wall of generated text that says nothing checkable. Short, specific, and honest beats long and fluent.
- Hiding a breaking change, a skipped test, or a known failure anywhere but the top.
- Requesting review from a dozen people. The project's normal routing is enough.

## Close-out

The opened PR should let a maintainer answer four questions in under a minute: what, why, how do I know it works, and what do you want from me. If any answer needs a follow-up comment from you, the description is not finished.

Wersje

RepozytoriumWynikLicencja
Ta strona · Epsilon0xCell/pr-shepherd-skills100MIT
tanstack/ai100MIT
dxos/dxos100Apache-2.0
sanity-io/sanity100MIT
gosodax/sodax-sdks100MIT
jdx/mise100MIT
Kuan-AI-com/agent-skills100MIT
basicmachines-co/basic-memory100AGPL-3.0
The01Geek/prflow100MIT

Migawka bazy z 13.11.2026 · wersja paczki d1ca75b272a3 (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

  • 90visual-pr
    Pisze lub odświeża opis pull requesta z diagramami tego, co się zmieniło, przy każdym otwieraniu PR w repozytorium.
  • 92pr
    Pomaga napisać opis pull requesta: co się zmieniło, dlaczego i jak to sprawdzić.
  • 92pr
    Pomaga napisać opis pull requesta: co się zmieniło, dlaczego i jak to sprawdzić.
  • 100descriptions
    Przygotowuje lub poprawia opis pull requesta, gdy użytkownik prosi o PR description, podsumowanie PR lub opis zmiany.
  • 90pr
    Pisze lub aktualizuje opis pull requesta przed uruchomieniem gh pr create.
  • 100create-pr-description
    Generuje uporządkowany opis pull requesta ze zmian przygotowanych w git.

Uwagi i zgłoszenia

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