En este artículo, quiero compartir contigo algunas buenas prácticas para hacer commits en Git. Te invito a leerlo con atención, ya que esto te ayudará a comprender mejor cómo estructurar correctamente tus commits.
Un commit en Git es una forma de guardar los cambios realizados en el código. Es importante seguir ciertas prácticas para que estos commits sean claros y útiles tanto para ti como para otros desarrolladores que trabajen en el proyecto.
A continuación, te describo algunas recomendaciones esenciales.
📝 Mensajes de commit claros y descriptivos
El mensaje de commit es fundamental para entender los cambios realizados. Debe ser claro y descriptivo. Un buen mensaje de commit incluye un resumen breve de máximo 72 caracteres de los cambios realizados y, si es necesario, un cuerpo detallado explicando más a fondo.
Por ejemplo, en lugar de usar "Bug fix", es mejor ser específico: "[FIX] Resolve null pointer exception when user logs out".
💬 Uso de verbos en tiempo presente
Utiliza verbos en tiempo presente en los mensajes de commit. Esto sigue la convención de que el mensaje describe lo que hace el commit cuando se aplica. Por ejemplo, "Add user login feature" en lugar de "Added user login feature".
🔖 Uso de etiquetas en los mensajes de commit
Para mayor claridad y organización, utiliza etiquetas en los mensajes de commit. Esto ayuda a identificar rápidamente el propósito del commit. Algunas etiquetas comunes son:
- [FIX]: Correcciones de errores.
- [NEW]: Nuevas funcionalidades.
- [UPDATE]: Actualizaciones de funcionalidades existentes.
- [DOC]: Cambios en la documentación.
- [STYLE]: Cambios que no afectan la lógica del código (formateo, estilo).
Por ejemplo: "[STYLE] Change color of the navbar" o "[NEW] Add user login feature".
🔄 Referenciar issues o tickets
Si los cambios están relacionados con un issue o ticket en un sistema de seguimiento, refiérelo en el mensaje de commit. Esto proporciona un contexto adicional y facilita la navegación entre los cambios y los problemas que resuelven.
Por ejemplo, "[FIX] TICKET-123: Resolve login timeout issue".
🔍 Realizar commits pequeños y frecuentes
Es una buena práctica realizar commits pequeños y frecuentes. Esto facilita la revisión de los cambios y permite identificar errores de manera más sencilla. Cada commit debe representar un cambio lógico y cohesivo en el código.
Por ejemplo, si estás trabajando en una nueva funcionalidad, realiza un commit para la estructura inicial, otro para la implementación y otro más para las pruebas.
✔️ Agrupar cambios relacionados
Asegúrate de que cada commit agrupe cambios relacionados. No mezcles correcciones de errores, nuevas funcionalidades y mejoras de rendimiento en un solo commit. Esto ayuda a mantener un historial de cambios limpio y fácil de seguir.
Si estás corrigiendo un bug y añadiendo una nueva función, hazlo en commits separados.
🕐 Tomarse el tiempo para revisar
Antes de realizar un commit, tómate el tiempo para revisar los cambios que estás a punto de registrar. Asegúrate de que no haya errores y que todos los cambios estén justificados. Esto te ayudará a mantener la calidad del código.
¿Te han servido de ayuda estos consejos?
Dímelo en los comentarios.
