Configuración de una plantilla de commit en git: una guía paso a paso

Escribir buenos mensajes de commit puede ser difícil cuando se trabaja a ritmo acelerado. Sin una estructura, es fácil terminar con commits vagos e inconsistentes que ralentizan las revisiones de código y el seguimiento del proyecto.

Una plantilla de commit de Git ayuda proporcionando un punto de partida cada vez que creas un commit. Hace que escribir mensajes claros sea más rápido y consistente.

En este artículo, aprenderás exactamente cómo crear y utilizar una plantilla de commit de Git para mejorar la calidad de tus commits sin ralentizar tu flujo de trabajo.

¿Qué es una plantilla de commit de Git?

Una plantilla de commit de Git es un archivo preescrito que aparece cada vez que ejecutas git commit sin la bandera -m. Proporciona un formato estructurado o recordatorios para escribir mejores mensajes de commit.

En lugar de comenzar con una pantalla en blanco, ves indicaciones útiles como:

# Título del commit (50 caracteres o menos)

# Descripción: ¿Por qué es necesario este cambio?

# Referencia a incidencia (opcional):

Puedes editar estas líneas antes de finalizar tu commit.

Cómo crear una plantilla de commit de Git

Paso 1: Crear un archivo de plantilla

Crea un archivo de texto en algún lugar de tu sistema, por ejemplo:

nano ~/.gitmessage.txt

Dentro del archivo, añade una estructura simple:

# Título: (resumen breve, máximo 50 caracteres)

# Descripción:
# - Explica por qué este cambio es necesario
# - Menciona cualquier contexto o antecedente

# Incidencias relacionadas:
# - Referencia números de ticket o enlaces

Guarda y cierra el archivo.

Paso 2: Configurar Git para usar la plantilla

Indica a Git que use este archivo como plantilla de mensaje de commit:

git config --global commit.template ~/.gitmessage.txt

Esto aplica la plantilla en todos tus repositorios.

Paso 3: Comienza a usarla

Cuando creas un commit sin un mensaje en línea:

git commit

Git abre tu editor predeterminado con la plantilla cargada. Rellenas las secciones, guardas y cierras el editor para finalizar el commit.

Si prefieres hacer commits con mensajes en línea usando -m para correcciones rápidas, aún puedes hacerlo. La plantilla solo aparece cuando omites -m.

Un ejemplo de plantilla mejorada

Puedes personalizar las plantillas para adaptarlas al flujo de trabajo de tu equipo. Aquí hay un ejemplo más detallado:

# Tipo: [feat|fix|docs|refactor|test|chore]
# Ámbito: (nombre de módulo o archivo opcional)
# Asunto: (descripción imperativa breve)

# Cuerpo:
# - Motivación y contexto
# - Enlace a incidencias o tickets relacionados

# Pie:
# - Cambios importantes que rompen compatibilidad
# - Discusiones relacionadas

Este enfoque coincide con los estándares comunes de Conventional Commits.

Por qué usar una plantilla de commit de Git

• Consistencia: Tu historial será mucho más fácil de leer.
• Velocidad: No es necesario pensar en el formato cada vez.
• Mejores revisiones de código: Los commits claros aceleran la revisión por pares.
• Depuración más fácil: Puedes rastrear errores y cambios de manera más eficiente.

Relacionado: Cómo crear y usar alias de Git para un flujo de trabajo más rápido

Conclusión

Una plantilla de commit de Git es una herramienta simple pero poderosa para mejorar la calidad del código y la colaboración del equipo. Al tomarte unos minutos para configurar una, ahorrarás tiempo, reducirás la confusión y escribirás mejores commits desde el primer día.

Preguntas frecuentes