Cómo mejorar tus mensajes de commit en Git usando Conventional Commits

Cuando trabajamos con código, explicar a los demás lo que hicimos no es fácil. La forma de escribir mensajes de commit para comunicar nuestros cambios suele variar según cada miembro del equipo. Cada persona tiene su propia manera de redactar sus commits y, a veces, ni siquiera sabemos qué escribir en ellos.

Cada integrante del equipo comunica sus cambios de forma distinta, lo que dificulta entender qué modificaciones ocurrieron en el proyecto. ¿Qué pasaría si establecemos un estándar o un acuerdo de equipo para escribir los mensajes de commit?

La solución es usar Conventional Commits.

Conventional Commits

Conventional Commits es una especificación que nos ayuda a redactar mensajes semánticos siguiendo ciertas reglas. Estas reglas facilitan saber con claridad qué y cómo escribir nuestros commits.

Ejemplo de Conventional Commits en Git

Al escribir un commit siguiendo la guía de Conventional Commits, la estructura es la siguiente:

type: scope: description or message
optional body
optional footer

El type expresa la intención y el scope indica el área afectada. Por ejemplo:

fix: (icon-library) 
Change the input prop of the state icon to match the identifier.
Refs: #jira-ticket-number or pbi

Otras opciones disponibles son:

• feat: una nueva característica o funcionalidad.

• fix: cuando corregimos un error o bug.

• docs: cambios en documentación, edición de archivos markdown, etc.

• chore: cambios que no afectan el código fuente ni las pruebas.

También cuentas con opciones adicionales como test, revert, build, ci, styles o BREAKING CHANGE. Para conocer más opciones, puedes revisar la documentación oficial.

¿Cómo escribo Conventional Commits?

En mi caso, prefiero usar una extensión en lugar de escribir la estructura manualmente cada vez, facilitando el proceso con un solo clic al integrarlo en mi editor o en la terminal.

VSCode: https://marketplace.visualstudio.com/items?itemName=vivaxy.vscode-conventional-commits

WebStorm: https://plugins.jetbrains.com/plugin/13389-conventional-commit

Terminal: https://ttys3.github.io/git-cz/

Soy un gran seguidor de GitKraken, pero lamentablemente aún no tienen soporte para Conventional Commits. Sin embargo, puedes apoyarme votando por la iniciativa para integrarlo.

🙏🏽 Por favor firma y vota en https://feedback.gitkraken.com/suggestions/198202/conventional-commits-support

Resumen

Aprendimos cómo usar Conventional Commits para tener un estándar claro al redactar mensajes de commit, haciendo que sea mucho más sencillo para todos los miembros del equipo entender los cambios en el código.

Espero que te animes a utilizarlo con alguna extensión en tu editor o terminal en tus próximos proyectos.