Pr Doc

pr-doc — Título e Descrição de Pull Request

Por que esta skill existe

No final de uma sessão, depois de implementar tudo, escrever um bom título e uma boa descrição de PR dá trabalho — e é o que faz outra pessoa entender a mudança em segundos. Esta skill aproveita o contexto da sessão (que já tem todo o histórico do que foi feito e do porquê) para gerar esse texto pronto, sem que você precise re-explicar nada.

Importante: esta skill não cria o PR. Ela só gera o título e a descrição e copia pro clipboard. Você abre o PR manualmente e cola.

Quando executar

• O usuário pediu explicitamente (ex: "/pr-doc", "gerar descrição de PR", "texto do PR")
• A implementação da sessão está concluída e o próximo passo é abrir um PR
• O usuário menciona que vai criar o PR à mão e quer o texto pronto

Como gerar

Siga os passos na ordem:

Passo 1 — Analisar o contexto da sessão

Revise toda a conversa e identifique:

• O quê foi implementado/alterado (funcionalidade, fix, refactor)
• Por quê — o problema ou necessidade que motivou a mudança
• Entidades e arquivos afetados (modelos, services, endpoints, migrations, componentes)
• Como validar — testes rodados, comportamento esperado
• Pendências, riscos ou pontos de atenção

Opcionalmente, para confirmar a lista de arquivos alterados, rode git diff --stat e git diff --name-status (apenas leitura, para enriquecer a seção de entidades). A fonte principal continua sendo o contexto da sessão.

Passo 2 — Gerar o título

Regras do título:

• Português técnico, claro e no imperativo (ex: "Implementa faturação recorrente no billing",

"Corrige cálculo de impostos em pedidos parciais", "Refatora autenticação para usar JWT")

• Diz o que a mudança faz, não como — direto ao ponto
• Sem prefixos de tipo (não usar "feat:", "fix:") a menos que o usuário use esse padrão
• Uma linha, sem ponto final

Passo 3 — Gerar a descrição

Escreva a descrição em Markdown (renderiza bonito no GitHub/GitLab) seguindo este molde. Omita seções que não se aplicam — a descrição deve ser enxuta.

## Resumo

1-2 frases: o que esta mudança entrega e por quê. Suficiente pra entender o PR sem rolar.

## O que muda

- Item técnico e conciso do que foi feito
- Outro item
- ...

## Entidades e arquivos afetados

| Entidade / Arquivo | Tipo | O que mudou |
|--------------------|------|-------------|
| `app/models/invoice.rb` | Novo | Modelo de fatura com status e vencimento |
| `app/services/billing.rb` | Alterado | Adiciona faturação recorrente |
| `db/migrate/xxxx.rb` | Migration | Cria tabela `invoices` |

## Fluxo (opcional)

Incluir um diagrama Mermaid apenas quando ajuda a entender o fluxo. Caso contrário, omitir.

```mermaid
flowchart LR
  A[Pedido] --> B[BillingService]
  B --> C[(invoices)]
  B --> D[Notificação]

Como testar

• Passo objetivo de validação
• Testes rodados / comando

Notas e riscos (opcional)

• Pontos de atenção, breaking changes, follow-ups

### Passo 4 — Copiar pro clipboard

Copie a **descrição completa** pro clipboard (o título também, mostrado em destaque na tela):

- **macOS:** `pbcopy`
- **Linux:** tentar `xclip -selection clipboard` ou `xsel --clipboard --input`

Se o comando falhar, apenas mostre o texto para o usuário copiar manualmente.

### Passo 5 — Informar o usuário

Diga ao usuário:

1. O **título** gerado (em destaque, pronto pra copiar)
2. Que a **descrição** está no clipboard (ou mostre na íntegra pra copiar)
3. Lembre que ele deve **criar o PR manualmente** e colar esse conteúdo

## Regras de qualidade

- **Baixa carga cognitiva** — dá pra bater o olho e entender; use tabelas e listas, evite parágrafos longos
- **Denso, não prolixo** — cada linha carrega informação útil; descrição enxuta
- **Foco no PORQUÊ além do QUÊ** — a descrição deve explicar a motivação, não só listar mudanças
- **Nomes concretos** — use `app/services/billing.rb` e `InvoiceService`, nunca "o service principal"
- **Diagrama só quando agrega** — não force Mermaid; omita se não esclarecer
- **Não criar o PR** — esta skill só gera texto; quem abre o PR é o usuário
- **Título técnico e claro** — em PT-BR, no imperativo, sem enrolação

## Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

- **Author:** [Vilsonranijak](https://github.com/Vilsonranijak)
- **Source:** [Vilsonranijak/claude-code-skills](https://github.com/Vilsonranijak/claude-code-skills)
- **License:** MIT

Install and usage instructions live in the source repository linked above.