Escribiendo mensajes de commit en Git

Los mensajes de commit en Git son fundamentales para indicar el estado en el que se encuentra el proyecto y lo que se van a encontrar nuestros compañeros al hacer checkout de ese commit o branch.

Aunque muchos proyectos de software libres siguen reglas de estilo y concisión para esos mensajes de commit, al día a día para nuestros proyectos en el trabajo o personales no seguimos ninguna regla en concreto.

Si nos paramos a revisar uno a uno nuestros mensajes de commit, quizás nos encontremos con descripciones vagas, inexactas, mucho “valdanismo” hablando de clases y métodos que se han refactorizado o simplemente un triste “bug fixed”.

Hace tiempo hablamos de una serie de consejos para mejorar nuestros comentarios en los commit que conviene recordar y ampliar:

• Hablar sobre las funcionalidades del nuevo código, no sobre ti mismo. Muchas veces caemos en el error de hablar sobre lo que hicimos, obviando lo que hace actualmente el código modificado. Hay que fijar el objetivo de ese commit centrándonos en la historia de usuario que estamos realizando.

• Si queremos ampliar (dentro de un límite) podemos hablar de la motivación del cambio y contrastar la implementación con el comportamiento anterior.

• No hablar en pasado. Muchos ortodoxos opinan que lo mejor es usar la forma imperativa del verbo que usemos para indicar que hace este commit.

• Evitar referencias temporales en el mensaje de commit, la revisión ya incluye la fecha de modificación.

• Aportar meta información en los commmit. Si usamos herramientas integradas como Stash y Jira, podemos adjuntar los identificadores de las tareas que hayamos realizado en el commit para enlazar el código modificado con la propia historia. De esta forma podemos revisar el estado y ampliar la información de cada tarea de JIRA con el código fuente.

• Utilizar una primera frase de no más de 50 caracteres que resuma el contenido del commit. Muy útil si pensamos cuando nos movemos con herramientas como Sourcetree (en la vista general) o la terminal, donde sólo vemos la primera línea del commit.

¿Qué mensajes de commit os soléis encontrar en vuestros proyectos?

En Genbeta Dev | ¿Son nuestros comentarios en los commits lo suficientemente útiles?
Vía | 365Git