Prácticas recomendadas para mensajes de commit

Imagine que revisa el historial de su proyecto. Sin mensajes de commit claros, ¡sería como leer un diario con entradas en blanco!

Los buenos mensajes de commit son fundamentales para entender por qué se hicieron los cambios, qué se modificó y cómo afectan al proyecto. Esto le ayuda, tanto a usted como a su equipo, a depurar, revisar el código e incorporar a nuevos miembros.

Un mensaje de commit estándar de Git tiene dos partes principales:

• Línea de asunto: Una única línea concisa que resume el cambio.
• Cuerpo (opcional): Una explicación más detallada, separada del asunto por una línea en blanco.

Considérelo como un correo electrónico: una línea de asunto para una lectura rápida y un cuerpo para los detalles.

La línea de asunto es la parte más importante. Estas son las reglas:

• Concisión: Manténgala por debajo de 50-72 caracteres.
• Modo imperativo: Empiece con un verbo en presente (por ejemplo, "Add feature", no "Added feature" ni "Adding feature").
• Mayúscula inicial: Es una práctica estándar para facilitar la lectura.
• Sin punto: No termine la línea de asunto con un punto.

Veamos algunos ejemplos de líneas de asunto buenas y malas:

• Buena: Fix: broken login button
• Buena: Feat: implement user profile page
• Mala: Fixed a bug in the login system that was causing issues. (Demasiado larga y en pasado)
• Mala: updates (Demasiado vaga)

¡Procure que sea clara y concisa!

En el cuerpo del commit se explica la motivación del cambio, el contexto y cualquier detalle que no resulte evidente al examinar el código.

Utilícelo cuando su cambio necesite más explicación de la que puede proporcionar la línea de asunto. Mantenga las líneas alrededor de 72 caracteres para mejorar la legibilidad en las herramientas de Git.

Al escribir el cuerpo:

• Explique por qué se hizo el cambio, no solo qué se cambió.
• Describa las concesiones o decisiones de diseño.
• Mencione los posibles efectos secundarios o las áreas que deben supervisarse.
• Deje una línea en blanco entre el asunto y el cuerpo.

Esto proporciona un contexto valioso a los lectores futuros.

Este es un ejemplo de cómo podría ser un mensaje de commit completo y bien estructurado:

Muchos equipos adoptan una convención según la cual la línea de asunto comienza con un prefijo de tipo. Esto ayuda a categorizar rápidamente los cambios.

Entre los prefijos habituales se incluyen:

• feat: (nueva funcionalidad)
• fix: (corrección de errores)
• docs: (cambio en la documentación)
• style: (estilo del código, sin cambios funcionales)
• refactor: (refactorización del código)
• test: (añadir pruebas)
• chore: (mantenimiento y cambios en el proceso de compilación)

Es una buena práctica vincular sus commits con los issues o pull requests relacionados en su sistema de gestión de proyectos (por ejemplo, GitHub Issues o Jira).

Puede hacerlo incluyendo frases como Closes #123, Fixes #45 o Refs #67 en su mensaje de commit, normalmente en el cuerpo. Esto conecta automáticamente sus cambios de código con la tarea que se está siguiendo.

Según las prácticas recomendadas, ¿cuáles de las siguientes son características de un mensaje de commit de Git bien redactado?

Ha aprendido que los mensajes de commit bien redactados son fundamentales para la claridad del proyecto y la colaboración. ¡Al seguir estas prácticas recomendadas, convierte el historial de su proyecto en un recurso valioso!

• Mantenga las líneas de asunto concisas y en modo imperativo.
• Utilice el cuerpo para explicar «por qué» se hizo un cambio.
• Considere utilizar prefijos de tipo para categorizar los cambios.
• Incluya enlaces a issues o pull requests para aportar contexto.

¡Feliz trabajo con sus commits!