Cómo escribir commits como un profesional
Los Commits Convencionales ofrecen un marco ligero pero poderoso para organizar los mensajes de commit. Al categorizar los cambios en tipos distintos como características, correcciones y cambios importantes, establece un estándar de oro para la claridad y la coherencia y se alinea con Semantic Versioning (SemVer).
La Anatomía de un Gran Mensaje de Commit
Al hacer commits, utiliza el formato de commit convencional, que generalmente sigue el patrón de <type>: <description>.
Un mensaje de commit debe seguir esta estructura:
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]-
type: tipo de commit -
scope: Descripción breve de una sección del código encerrada entre paréntesis seguida de dos puntos y un espacio. Los mensajes tienden a estar en presente e imperativo. -
description: Descripción breve de los cambios en el código -
body: Una descripción más larga del commit, proporcionando contexto adicional sobre los cambios. Debe colocarse una línea en blanco después de la descripción. -
footer: Ejemplo: "Fixes issue #3". El pie de página solo debe contener referencias adicionales a problemas relacionados con los cambios.
Ejemplos:
Un commit que hice para resolver un problema.
feat(homepage): Add carousel feature to showcase testimonials
Implemented a carousel component on the homepage
Added client testimonials section for improved user engagement
Fixes #12Más ejemplos:
- feat: Add new rating component
- fix: Resolve issue with city search feature
- docs: Update README with new contribution guidelines
Tipos de Commits
Además de los clásicos fix y feat, tenemos toda una variedad de tipos de commits. Es como elegir ingredientes para tu pizza de commits:
-
build: Cambios relacionados con los procesos o herramientas de construcción. -
chore: Tareas de mantenimiento o administrativas regulares. -
ci: Actualizaciones en la configuración de integración continua. -
docs: Cambios relacionados con la documentación. -
style: Cambios que no afectan la funcionalidad del código (por ejemplo, formato). -
refactor: Modificaciones del código sin cambiar su comportamiento. -
perf: Mejoras en el rendimiento. -
test: Adición o modificación de pruebas.
Puedes usar estos tipos para categorizar tus commits según su naturaleza. Esto ayuda a mantener la coherencia en los mensajes de commit y facilita una mejor organización de los cambios en el historial del proyecto.
Para obtener más información sobre Commits Convencionales, visita Especificación de Commits Convencionales.
Jorge García
Fullstack developer