Notes on submodules A great way to split up a project into smaller modules
Resources:
https://gist.github.com/gitaarik/8735255
- Adding a submodule:
git submodule add https://github.com/eonist/SVGWrapper.git Packages/External/SVGWrapper/
Editing existing
- Delete the folder with the submodule
- Delete ref in .submodules and Delete ref in .git/.config (⚠️️ This part can sometimes be skipped ⚠️️)
- force add with:
git submodule add --force https://github.com/eonist/With.git Packages/Remote/With/
Resetting submodule
Sometimes editing or changing a submodule just creates an avalanche of issues. So resetting is a better option
- Compress your project, to back it up (This can be smart to do even when adding a submodule etc, submodule is DarkMagic(TM) )
git reset --hard
- Add submodules ✨
Gotchas:
- Updating submodules:
git submodule update --remote