[Sugerencia] Recomendaciones para Hacer un Commit Efectivo en GitHub

Recomendaciones para Hacer un Commit Efectivo en GitHub

Comparto algunas buenas prácticas para realizar Commit en GitHub

Al realizar un commit en GitHub, es esencial que sea claro, conciso y significativo. Aquí te dejo algunas recomendaciones para lograrlo, junto con ejemplos prácticos:

1. Usa mensajes descriptivos: Es importante que el mensaje del commit explique qué cambios se han realizado y por qué. Esto facilita la comprensión para otros desarrolladores (o para ti mismo en el futuro).

   Ejemplo:

   Correcto: "Corrige error en la validación de formularios de registro"
   Incorrecto: "Arreglo bug"
   

2. Haz commits pequeños y específicos: Realiza commits que contengan cambios relacionados entre sí. Evita agrupar múltiples modificaciones de diferentes temas en un solo commit.

   Ejemplo:

   • Si has corregido un error y añadido una nueva función, haz dos commits separados:
     1. "Corrige error de despliegue en la página de inicio"
     2. "Añade funcionalidad de búsqueda por categoría"

3. Empieza con un verbo en infinitivo: Es una buena práctica comenzar el mensaje del commit con un verbo en infinitivo que describa la acción realizada.

   Ejemplo:

   Correcto: "Añadir validación al formulario de contacto"
   Incorrecto: "Validación añadida"
   

4. Usa el modo imperativo: Similar al punto anterior, es recomendable usar el modo imperativo (como si estuvieras dando una orden).

   Ejemplo:

   Correcto: "Actualiza dependencias del proyecto"
   Incorrecto: "Actualizado dependencias del proyecto"
   

5. Incluye referencias a tickets o issues si es relevante: Si el commit está relacionado con un ticket, issue, o tarea específica, inclúyelo en el mensaje.

   Ejemplo:

   "Corrige error en el login de usuarios (Issue #45)"
   

6. Evita mensajes genéricos: Mensajes como "Actualización", "Cambios", o "Fix" no aportan información útil. Asegúrate de que cada commit tenga un mensaje que refleje exactamente lo que se ha modificado.

   Ejemplo:

   Correcto: "Elimina código obsoleto del módulo de autenticación"
   Incorrecto: "Actualización de código"
   

Siguiendo estas recomendaciones, tus commits serán más efectivos, facilitando la colaboración y el mantenimiento de tu código.

¡Saludos!