Aplicador de Flujo de Trabajo Git
Aplica flujos de trabajo Git consistentes, incluyendo mensajes de commit, nomenclatura de ramas y procesos de PR.
Cuándo Usarlo
- Al crear commits o ramas
- Durante revisiones de código o creación de PR
- Cuando el usuario mencione "flujo de trabajo git", "mensaje de commit", "nomenclatura de ramas" o "pull request"
Instrucciones
1. Detectar Convenciones Existentes
Verifica:
- Plantillas de
.github/o.gitlab/ CONTRIBUTING.md- Patrones de mensajes de commit existentes
- Patrones de nomenclatura de ramas
2. Commits Convencionales
Formato: tipo(ámbito): descripción
Tipos:
feat: Nueva funcionalidadfix: Corrección de erroresdocs: Documentaciónstyle: Formato, punto y coma faltantesrefactor: Reestructuración de códigoperf: Mejora de rendimientotest: Adición de pruebaschore: Mantenimiento, dependencias
Ejemplos:
feat(auth): añadir soporte de inicio de sesión con OAuth2
fix(api): manejar respuesta nula en endpoint de usuario
docs(readme): actualizar instrucciones de instalación
refactor(utils): simplificar lógica de formato de fechas
3. Nomenclatura de Ramas
Patrones comunes:
feature/autenticacion-de-usuario
bugfix/manejo-de-error-de-inicio-sesion
hotfix/parche-de-seguridad-critico
release/v1.2.0
chore/actualizar-dependencias
Validar:
- Minúsculas con guiones
- Prefijado con tipo
- Nombre descriptivo
- Número de incidencia si aplica:
feature/123-anadir-modo-oscuro
4. Validación de Mensajes de Commit
Buen commit:
feat(payments): integrar pasarela de pago Stripe
- Configurar SDK de Stripe
- Implementar creación de intención de pago
- Añadir manejador de webhook para eventos de pago
- Actualizar pruebas para flujo de pago
Cierra #456
Verificar:
- Línea de asunto ≤50 caracteres
- Cuerpo envuelto a 72 caracteres
- Línea en blanco entre asunto y cuerpo
- Modo imperativo ("añadir" no "añadido")
- Referencia a incidencia/ticket
5. Plantilla de PR
Crear .github/PULL_REQUEST_TEMPLATE.md:
## Descripción
<!-- ¿Qué hace este PR? -->
## Tipo de Cambio
- [ ] Corrección de errores
- [ ] Nueva funcionalidad
- [ ] Cambio disruptivo
- [ ] Actualización de documentación
## Pruebas
<!-- ¿Cómo se probó esto? -->
## Lista de Verificación
- [ ] El código sigue las guías de estilo del proyecto
- [ ] Se realizó una autoevaluación
- [ ] Se añadieron comentarios para código complejo
- [ ] Se actualizó la documentación
- [ ] Se añadieron/actualizaron pruebas
- [ ] Todas las pruebas pasan
- [ ] No hay nuevas advertencias
## Incidencias Relacionadas
Cierra #
6. Hooks de Commit
Pre-commit:
#!/bin/sh
# .git/hooks/pre-commit
# Ejecutar linter
npm run lint
# Ejecutar pruebas
npm test
# Verificar datos sensibles
if git diff --cached | grep -i "password\|api_key\|secret"; then
echo "Error: Posibles datos sensibles detectados"
exit 1
fi
Commit-msg:
#!/bin/sh
# .git/hooks/commit-msg
commit_msg=$(cat "$1")
# Verificar formato de commit convencional
if ! echo "$commit_msg" | grep -qE "^(feat|fix|docs|style|refactor|perf|test|chore)(\(.+\))?: .+"; then
echo "Error: El mensaje de commit debe seguir el formato de Commits Convencionales"
echo "Ejemplo: feat(auth): añadir funcionalidad de inicio de sesión"
exit 1
fi
7. Validar Commits Existentes
Revisa commits recientes para verificar adherencia al patrón:
git log --oneline -20 | grep -v "^[a-f0-9]\{7\} (feat|fix|docs|style|refactor|perf|test|chore)"
8. Generar Changelog
A partir de commits convencionales:
# Usando standard-version
npx standard-version
# O agrupar manualmente por tipo
git log --pretty=format:"%s" | grep "^feat" > features.txt
git log --pretty=format:"%s" | grep "^fix" > fixes.txt
9. Ramas Protegidas
Configuración de GitHub:
- Requerir revisiones de PR
- Requerir verificaciones de estado
- Requerir commits firmados
- Restringir quién puede hacer push
- Requerir historial lineal
10. Mejores Prácticas
- Commits atómicos: Un cambio lógico por commit
- Mensajes descriptivos: Explicar el por qué, no el qué
- Commits frecuentes: Pequeños y frecuentes sobre grandes y raros
- Historial limpio: Squash/rebase antes de fusionar
- Firmar commits: Firma GPG para seguridad
- Referenciar incidencias: Vincular al sistema de seguimiento
Plantilla de Commit Git
Crear .gitmessage:
<tipo>(<ámbito>): <asunto>
<cuerpo>
<pie>
# Tipo: feat, fix, docs, style, refactor, perf, test, chore
# Ámbito: componente o archivo afectado
# Asunto: imperativo, minúsculas, sin punto final, ≤50 caracteres
# Cuerpo: explicar qué y por qué, no cómo, envuelto a 72 caracteres
# Pie: cambios disruptivos, referencias a incidencias
Establecer como plantilla:
git config --global commit.template ~/.gitmessage
Archivos de Soporte
templates/PULL_REQUEST_TEMPLATE.mdtemplates/commit-msg-hook.shtemplates/.gitmessage