Usa el Crear Mensajes de Commit Convencionales gratuito abajo: tus datos nunca salen de tu navegador, todo el trabajo ocurre en tu dispositivo y no se sube a ningún servidor.
Los Mensajes de Commit Son Documentación, No un Detalle Menor
Un mensaje de commit es lo primero que lee un compañero cuando pregunta por qué se hizo un cambio, y lo primero que lee una herramienta automática cuando crea un registro de cambios o decide el siguiente número de versión. Mensajes como arreglado o actualizaciones no dicen nada a nadie, y rompen toda herramienta que depende de un formato predecible. Conventional Commits resuelve esto con una estructura pequeña y estricta: un tipo, un ámbito opcional, una descripción, y secciones opcionales de cuerpo y pie.
Este creador escribe esa estructura por ti. Eliges un tipo como feat para una función nueva o fix para corregir un error, añades un ámbito opcional como login o api, escribes una descripción corta, y añades un cuerpo o pie cuando el cambio necesita más explicación. La herramienta revisa las reglas comunes mientras escribes: descripciones de más de 72 caracteres, una primera letra en mayúscula, o un punto final reciben un aviso suave, para que el mensaje que copies sea uno en el que tu equipo y tus herramientas puedan confiar.
Cómo Usarlo
Elige el tipo, añade un ámbito si el cambio pertenece a una parte del código, escribe la descripción, y añade un cuerpo o pie solo cuando sea necesario. Pulsa Crear y copia el mensaje terminado.
- Elige el tipo que encaje con el cambio: feat, fix, docs, refactor, y el resto.
- Añade un ámbito si el cambio toca un área, como login, api o checkout.
- Marca Cambio importante solo si el cambio rompe el comportamiento existente para usuarios u otro código.
- Escribe una descripción corta en modo imperativo, como fix password reset link expiry.
- Añade un cuerpo con el porqué, si la descripción sola no explica el cambio.
- Añade un pie con referencias, como Closes #123, y luego copia el mensaje.
Un Ejemplo Práctico
Un error de restablecimiento de contraseña es un fix clásico: tipo fix, ámbito login, descripción fix password reset link expiry, y el resultado es fix(login): fix password reset link expiry. Si la corrección también cambia el formato del enlace de restablecimiento de forma que rompe enlaces antiguos, marca Cambio importante y la herramienta añade un signo de exclamación y un pie BREAKING CHANGE, lo que indica a las herramientas de versiones que este es un cambio mayor. Un pie como Closes #123 enlaza el commit con el problema que resuelve, así que el problema se cierra solo cuando el commit se fusiona.
Consejos Que Ahorran Tiempo
- Usa el modo imperativo: fix, add, change, no fixed, added, ni changes.
- Mantén la descripción por debajo de 72 caracteres para que se muestre completa en registros y herramientas.
- Usa el cuerpo para el porqué, no para repetir el qué. La descripción ya dice qué cambió.
- Usa feat solo para funciones nuevas visibles para el usuario, y fix solo para corregir errores, para que los números de versión se calculen correctamente.
- Sé constante. Un equipo que usa los mismos tipos y ámbitos obtiene registros de cambios que prácticamente se escriben solos.
Errores Comunes Que Debes Evitar
El error más común es usar feat para cada cambio, lo que infla los números de versión y hace inútiles los registros de cambios. Otro es escribir una descripción que solo tiene sentido con conocimiento interno, como arreglado otra vez, que no ayuda a nadie dentro de seis meses. Un tercero es marcar un cambio como importante cuando no lo es, o no marcar un cambio realmente importante, y ambas cosas engañan a todos los que dependen del número de versión. En caso de duda, describe el impacto para el usuario con honestidad.
Preguntas Frecuentes
¿Cuál es la diferencia entre feat y fix? Un feat añade una función nueva para los usuarios y suele provocar un aumento de versión menor, mientras que un fix corrige un error y suele provocar un aumento de parche.
¿Necesito un ámbito? No, el ámbito es opcional. Úsalo cuando el cambio pertenece claramente a un área, y omítelo para cambios generales.
Los buenos mensajes de commit tardan diez segundos más y ahorran horas después. Crea el mensaje aquí, revisa los avisos, y confirma con un mensaje que valga la pena leer.
Pingback: Convertir Markdown a Texto Plano Gratis - Quita el Formato Markdown