Existen convenciones comunes para escribir mensajes de commit en Git que ayudan a proporcionar información clara y concisa sobre los cambios realizados. A continuación, se presentan algunas convenciones ampliamente utilizadas:
1. Incluir un encabezado descriptivo:
El encabezado del mensaje de commit debe ser breve y descriptivo. Debe resumir de manera clara y concisa el propósito del commit en una línea. Por ejemplo: "Agregar función de autenticación" o "Corregir error de validación en el formulario".
2. Utilizar oraciones en imperativo:
Es común utilizar oraciones en imperativo en el mensaje del commit para describir el cambio realizado. Por ejemplo: "Agregar", "Actualizar", "Corregir" en lugar de "Agregado", "Actualizado", "Corregido".
3. Separar el encabezado del cuerpo:
Si el mensaje de commit requiere más detalles, se puede incluir un cuerpo separado después del encabezado. El cuerpo proporciona información adicional y más detallada sobre el cambio realizado. Se separa del encabezado por una línea en blanco.
4. Limitar la longitud de línea:
Es recomendable limitar la longitud de línea en los mensajes de commit a 72 caracteres o menos. Esto facilita la legibilidad en diferentes interfaces y herramientas.
5. Utilizar mensajes en presente:
Se recomienda utilizar mensajes de commit en tiempo presente para describir el cambio realizado. Por ejemplo: "Agrega función de búsqueda" en lugar de "Agregó función de búsqueda".
6. Referenciar problemas o solicitudes de extracción:
Si el commit está relacionado con un problema o una solicitud de extracción (pull request) en un sistema de seguimiento de problemas o en una plataforma de colaboración, se puede incluir una referencia a dicho número o enlace en el mensaje del commit. Por ejemplo: "Corregir error de validación en el formulario (#123)".
Recuerda que estas convenciones son recomendaciones y pueden variar según el proyecto, el equipo de desarrollo y las preferencias establecidas. Lo importante es que los mensajes de commit sean claros, descriptivos y brinden información útil sobre los cambios realizados en el repositorio.
Estas convenciones pueden variar según el proyecto o el equipo de desarrollo, pero aquí hay algunos ejemplos comunes de tipos de commit que se utilizan en muchas prácticas de desarrollo:
1. feat: Utilizado para commits que agregan una nueva característica o funcionalidad al proyecto.
2. fix: Utilizado para commits que corrigen un error o un problema existente en el código.
3. docs: Utilizado para commits relacionados con cambios en la documentación del proyecto, como actualizaciones en archivos README, documentación de código, etc.
4. refactor: Utilizado para commits que realizan cambios en el código para mejorar su estructura, eficiencia o legibilidad, sin agregar nuevas características ni corregir errores.
5. style: Utilizado para commits que realizan cambios en el formato, estilo o convenciones de codificación, como cambios de espaciado, indentación, nombre de variables, etc.
6. test: Utilizado para commits relacionados con pruebas, como agregar nuevos casos de prueba, mejorar la cobertura de pruebas existentes, etc.
7. chore: Utilizado para commits que realizan tareas de mantenimiento o ajustes generales en el proyecto, como actualizaciones de dependencias, configuraciones de herramientas, cambios en la estructura de archivos, etc.
Estos son solo ejemplos de tipos de commit comunes, pero puedes adaptarlos según las necesidades y convenciones de tu proyecto o equipo de desarrollo. La idea es utilizar etiquetas descriptivas en los mensajes de commit para facilitar la comprensión y la navegación del historial de cambios del repositorio.
Want to print your doc? This is not the way.
Try clicking the ⋯ next to your doc name or using a keyboard shortcut (
Convenciones