¿Qué hace pr-writer?
Crea, actualiza y reescribe títulos y descripciones de PR siguiendo las convenciones de Sentry. Úsalo al abrir un PR, escribir o actualizar un título/cuerpo/descripción de PR, refrescar un PR existente después de cambios importantes o preparar cambios de rama para revisión.
Cómo usar
Ejecuta el siguiente comando en la terminal:
pr-writer [opciones]
Opciones
--title: Genera un título de PR basado en los cambios en la rama.--body: Genera un cuerpo de PR detallado.--refresh: Actualiza el título y la descripción de un PR existente según los últimos cambios.--rewrite: Reescribe el título y la descripción proporcionados para seguir las convenciones de Sentry.
Convenciones de Sentry
Los títulos de PR deben seguir el formato:
<tipo>(<alcance>): <descripción concisa>
Donde <tipo> puede ser:
feat: Nueva funcionalidadfix: Corrección de errorref: Refactorizacióntest: Pruebasdocs: Documentaciónchore: Tareas de mantenimiento
El cuerpo del PR debe incluir:
- Contexto: Explica por qué se realizan los cambios.
- Cambios: Lista los cambios principales.
- Notas de prueba: Describe cómo probar los cambios manualmente.
- Referencias: Enlaces a incidencias relacionadas (si aplica).
Ejemplo
pr-writer --title --body
Esto generará un título y un cuerpo de PR basados en las diferencias git diff entre la rama actual y main.
Notas importantes
- Asegúrate de estar en la rama correcta antes de ejecutar la herramienta.
- La herramienta no modifica directamente el PR en GitHub; genera el contenido para que lo copies o revises.
- Para actualizar un PR existente, usa
--refreshcon el número de PR.