Sub module

Notes on submodules A great way to split up a project into smaller modules


  • Adding a submodule:
    git submodule add Packages/External/SVGWrapper/

Editing existing

  1. Delete the folder with the submodule
  2. Delete ref in .submodules and Delete ref in .git/.config (⚠️️ This part can sometimes be skipped ⚠️️)
  3. force add with: git submodule add --force Packages/Remote/With/

Resetting submodule

Sometimes editing or changing a submodule just creates an avalanche of issues. So resetting is a better option

  1. Compress your project, to back it up (This can be smart to do even when adding a submodule etc, submodule is DarkMagic(TM) )
  2. git reset --hard
  3. Add submodules ✨


  • Updating submodules: git submodule update --remote