¿Eres un desarrollador que ha empezado a usar Git recientemente? Si te preguntas cómo crear un buen mensaje de commit para tu proyecto, entonces este artículo está hecho para ti.
Después de unas semanas de escribir, vuelvo hoy con un seguimiento de una de mis publicaciones más buscadas en Google.
Cuando empecé a escribir, hace un año, creé un artículo sobre cómo empezar y crear tu primer repositorio con Git.
Este artículo ayuda a mucha gente cada semana. Así que decidí escribir este post sobre cómo escribir un buen mensaje de commit para que puedas llevar tus habilidades en Git al siguiente nivel.
¿Qué es un buen mensaje de commit?
Como un breve recordatorio, un mensaje de commit es el texto corto que dejaste cuando guardaste tu trabajo en Git. Este mensaje tiene como objetivo identificar tu trabajo.
La idea es que con solo leerlo, cualquiera podrá entender claramente lo que hiciste en esta parte de tu trabajo.
Un buen ejemplo de commit
A continuación, puedes encontrar los últimos commits del proyecto Angular.js en GitHub. Como puedes ver, los mensajes son claros, y podemos entender mejor qué trabajo se ha hecho en las diferentes partes.
Por ejemplo, el 24 de julio de 2019, "gkalpak" actualizó "SauceConnect" y cambió a la última versión de Safari (el navegador web).
¿Por qué no todos realizan commits de la misma manera?
Desafortunadamente, no hay una forma universal de escribir commits. Cada proyecto y cada empresa definen reglas específicas para sus necesidades.
Pero no te preocupes, a menudo encontrarás formas similares de escribir un mensaje.
Para saber cuáles son, te recomiendo que leas las reglas antes de empezar en una empresa o de trabajar en un proyecto de código abierto.
Te daré más detalles sobre estas pautas más adelante en este artículo.
Por qué es esencial escribir bien tu commit
He creado una lista corta de las ventajas de usar un buen mensaje de commit.
Mejor colaboración
Si trabajas en una empresa, o en un proyecto de código abierto, es esencial seguir las reglas para una mejor cooperación. Si escribes algo comprensible, siguiendo las reglas del proyecto, otros desarrolladores podrán trabajar más eficientemente. No tendrán que hacer preguntas sobre tu trabajo.
Nota: Si estás trabajando en un proyecto personal, te recomiendo encarecidamente que también sigas unas normas específicas. Esto mejorará tu productividad, y si necesitas ayuda de otro desarrollador, será más fácil para ellos empezar a trabajar en tu proyecto.
Mejor entendimiento
Necesitas crear mensajes claros y comprensibles. Esto te ayudará a ti y a tu colaborador a trabajar juntos en un proyecto. A continuación, puedes encontrar un ejemplo de un historial de git commits con mensajes poco claros. Como verás, es difícil de entender lo que estaba pasando.
BONUS - Una generación de registro de cambios
Te diré un pequeño secreto: si escribes buenos mensajes, podrás generar un registro de cambios directamente desde tus mensajes de commits.
Aquí hay algunas herramientas para hacerlo:
También escribiré un próximo artículo sobre este tema. Si quieres estar al día, puedes seguirme en Twitter. Yo publico todas las actualizaciones allí.
Nota: Si quieres tener más ejemplos de malos commits y divertirte al mismo tiempo, una cuenta de Twitter llamada "gitlost" está twiteando todos los días con los commits divertidos y sin filtros.
Bien, ahora entremos en más detalles y veamos lo que realmente se necesita para escribir un buen mensaje de commit.
Cómo escribir un mensaje de commit
Si quieres escribir un buen mensaje de commit, tienes que seguir algunas reglas. He creado una lista de verificación a continuación. Cada vez que quieras hacer un commit, tómate el tiempo de consultar esta lista.
- Siempre revisa tu gramática. Nunca es agradable leer un mensaje lleno de errores. Para ello, te recomiendo que utilices una herramienta gramatical. Si escribes en inglés, puedes usar Grammarly, Reverso o GrammarCheck. Estar herramientas no son perfectas, pero eliminarán la mayoría de tus errores.
- Un commit, un cambio. Trata de realizar commits a menudo. Lo ideal es que cada cambio se haga en un commit diferente. Será más fácil para ti volver a tu trabajo anterior.
- Sé claro. Cuando escribas un commit, intenta ser lo más transparente posible. Te recomiendo que uses inglés (o español) sencillo y vayas directo al grano.
- Detalla lo que hiciste. Tómate el tiempo de releer tu código para escribir lo que hiciste. En caso de que necesites agregar muchos detalles, usa la parte de la descripción del commit.
El comando git commit
Quiero compartirte más detalles sobre el comando 'git commit'. Si no estás usando git software, debes saber que puedes crear commits detallados escribiendo este comando.
$ git commit -m "Título" -m "Descripción"
Es lo mismo que antes, pero con una segunda parte para la descripción. Así "-m 'título' " te permite escribir el título corto del commit, y "-m 'descripción' " te permite escribir la descripción si necesitas dar más detalles.
Usa directrices o pautas de git
Si quieres tener un historial de git commits claro, debes seguir algunas pautas. En mi caso elegí este simple de Udacity.
Hay muchas otras, como los Conventional Commits, y el Angular Guideline. Una pauta de commits te ayudará a estructurar tus commits.
Por ejemplo, añadiendo una etiqueta para aclarar lo que hiciste: "git commit -m 'fix: borra correctamente toda la información del usuario cuando se activa el botón de borrar la cuenta'".
Conclusión
¡Espero que te haya gustado esta guía sobre cómo realizar commits con Git! Si tienes alguna pregunta o comentario, no dudes en preguntar.
Si tienes algún otro consejo sobre cómo hacer buenos commits, por favor házmelo saber.
No te pierdas mi contenido siguiéndome en Twitter e Instagram.
Puedes encontrar otros artículos como este en mi sitio web: herewecode.io.
¿Quieres más?
- Cada semana recibe una cita motivacional con algunos consejos, un breve tutorial en una cuantas diapositivas, y una foto de un desarrollador en Instagram.
- Suscríbete al boletín de noticias y recibe los últimos artículos, cursos, tutoriales, consejos, libros, motivación y otros contenidos exclusivos.
Traducido del artículo de Gaël Thomas - A Beginner’s Guide to Git — How to Write a Good Commit Message