PR Description Writer
Redacta una descripción de pull request clara y estructurada a partir de un diff de...
Install
npx skills add mohitagw15856/pm-claude-skills --skill pr-description-writer -g -a claude-code -y- Repository
- mohitagw15856/pm-claude-skills1.5k
- Category
- Git and review
- Updated
- 3d ago
- License
- MIT
- Context cost
- Lightabout 1,125 tokens
- Runs scripts
- No, instructions only
What it does
Redacta una descripción de pull request clara y estructurada a partir de un diff de git, resumen de rama o lista de commits. Úsalo cuando te pidan escribir una descripción de PR, redactar una solicitud de cambios o documentar cambios de código. Produce una descripción con resumen, motivación, cambios realizados, pasos de prueba y orientación para revisores.
Habilidad de Redacción de Descripciones de PR
Redacta descripciones de pull request estructuradas y amigables para revisores a partir de un diff, lista de commits o notas informales. Cubre el qué, por qué y cómo revisar para que los revisores puedan empezar inmediatamente.
Inputs Requeridos
Solicita estos si no se proporcionan:
- Qué cambió (pega un git diff,
git log --oneline, o describe los cambios en texto plano) - Por qué cambió (el problema que se resuelve o la funcionalidad que se añade)
- Cómo probarlo (cualquier paso específico que un revisor necesite para verificar que funciona)
- Nivel de riesgo (bajo / medio / alto, afecta cuánta orientación para revisores incluir)
- Tipo de PR (feature / bug fix / refactor / dependency upgrade / config change / hotfix)
- Rama destino (p. ej. main / develop / release/2.4, afecta el encuadre de riesgo y la orientación para revisores)
- Issue o ticket vinculado (p. ej. JIRA-1234, GitHub #567, o "ninguno")
Formato de Salida
Título
Un título claro en modo imperativo de menos de 72 caracteres:
[type]: [descripción concisa de qué cambió]
Ejemplos:
feat: añadir rate limiting a la API públicafix: resolver race condition en expiración de sesiónrefactor: extraer lógica de pagos a PaymentService
Resumen
2, 3 oraciones que cubran:
- Qué hace este PR (el cambio)
- Por qué era necesario (el problema u objetivo)
- El enfoque adoptado (a alto nivel)
Cambios Realizados
Lista con viñetas de cambios específicos, una viñeta por cambio lógico, no por archivo:
- Añadido [X] para manejar [Y]
- Refactorizado [A] para reducir [B]
- Eliminado [C] ya que fue reemplazado por [D]
- Actualizado [E] para corregir [F]
