Cómo agregar un submódulo en Git

Si tienes un proyecto en GitHub y deseas incluir otro repositorio como si fuera una carpeta interna, puedes hacerlo utilizando submódulos de Git. Esto te permite mantener ambos repositorios sincronizados y organizados.

¿Qué es un submódulo?

Un submódulo es un repositorio Git dentro de otro. Permite incluir otro proyecto como parte de tu repositorio, sin copiar los archivos directamente.

Pasos para agregar un submódulo

1. Abre tu terminal y navega a la raíz de tu repositorio principal.
2. Agrega el submódulo usando el siguiente comando:

git submodule add https://github.com/usuario/repositorio-hijo.git nombre-de-carpeta

Ejemplo:

git submodule add https://github.com/miusuario/utils.git utils

3. Haz commit de los cambios:

git commit -m "Agregando submódulo"

git push

Clonando un repositorio con submódulos

Para clonar correctamente un proyecto que tiene submódulos, usa:

git clone --recurse-submodules https://github.com/usuario/repositorio-principal.git

Si ya lo habías clonado sin esa opción, ejecuta:

git submodule update --init --recursive

¿Por qué no usar ZIP?

Descargar el repositorio como ZIP desde GitHub no incluye el contenido de los submódulos. Verás una carpeta vacía. Por eso, es mejor usar git clone --recurse-submodules.

Recomendación

Agrega este mensaje en tu archivo README.md:

⚠️ Este proyecto usa submódulos. Usa este comando para clonar correctamente:
git clone --recurse-submodules https://github.com/usuario/repositorio-principal.git

Más información en la documentación oficial de Git.