Conceptos fundamentales de Git
Repository
Repository
La fuente de tu documentación, donde se almacenan todos los archivos y su historial. El Editor web se conecta a tu repositorio para acceder al contenido y modificarlo.
Commit
Commit
Una instantánea guardada de tus cambios en un momento específico. Cada commit incluye un mensaje que describe qué cambió y crea un registro permanente en el historial de tu proyecto.
Branch
Branch
Una rama apunta a un commit específico en tu repositorio. Tu documentación en producción se genera a partir de una rama de despliegue. Puedes tener cualquier cantidad de otras ramas con cambios que aún no se han publicado en tu documentación en producción. Si quieres incorporar los cambios de una rama a tu documentación en producción, puedes fusionarla en tu rama de despliegue mediante una pull request.Usa ramas para trabajar en cambios sin afectar tu documentación en producción, experimentar de forma segura con nuevas funciones y obtener revisiones antes de publicar.
Deployment branch
Deployment branch
La rama principal de tu proyecto a partir de la cual se genera el contenido de tu documentación en producción. Los cambios en esta rama se publican automáticamente en tu sitio de documentación. A menudo se llama
main
, pero puedes configurar cualquier rama como tu rama de despliegue.Pull request
Pull request
Una forma de proponer fusionar tus cambios de una rama en tu documentación en producción. Permite revisión y discusión antes de que los cambios se publiquen. Comúnmente llamada PR y también merge request en GitLab.
Diff
Diff
Un diff (o diferencia) muestra los cambios entre dos versiones de un archivo. Al revisar pull requests, los diffs resaltan lo que se ha agregado, eliminado o modificado, lo que facilita identificar qué cambió.
Cómo el editor web usa Git
- Abres un archivo: el editor obtiene la versión más reciente de tu repositorio, asegurando que siempre trabajes con contenido actualizado.
- Realizas cambios: el editor rastrea tus cambios como un borrador que puede convertirse en un commit cuando estés listo para guardar tu trabajo.
- Guardas los cambios: el editor crea un commit con tus cambios, preservando tu trabajo en el historial del proyecto.
- Creas una rama: el editor crea una nueva rama en tu repositorio que puede ser utilizada por cualquiera con acceso al repositorio para colaborar y revisar cambios.
- Publicas en tu rama de despliegue: el editor hace commit y push directamente a tu rama de despliegue, lo que publica tus cambios de inmediato.
- Publicas en otras ramas: el editor crea un pull request, lo que te permite obtener comentarios de otros antes de fusionar tus cambios en tu rama de despliegue.
Mejores prácticas de Git
- Escribe mensajes de commit descriptivos: Sé específico sobre qué cambió y usa un lenguaje activo.
- Usa nombres de rama descriptivos: Los nombres de las ramas deben explicar el trabajo que se está realizando y ser comprensibles para quien revise las ramas en tu repositorio.
- Mantén las ramas enfocadas: Limita los cambios de una rama a una tarea o proyecto específico.
- Elimina las ramas después de hacer merge: Borra las ramas cuando ya no las necesites para mantener tu repositorio ordenado.