Skip to content

SUBMODULE.md

Latest commit

 

History

History
99 lines (70 loc) · 2.4 KB

SUBMODULE.md

File metadata and controls

99 lines (70 loc) · 2.4 KB
Raw

Git Submodule: LibAMM

⚠️ This directory is a Git submodule - it's a separate repository!

Repository Information

Quick Guide for Committing Changes

1️⃣ Commit in This Submodule

# Navigate to this directory (if not already here)
cd packages/sage-libs/src/sage/libs/libamm

# Make your changes, then:
git add .
git commit -m "feat: your change description"
git push origin main-dev

2️⃣ Update Reference in Main Repository

# Navigate back to main repository root
cd ../../../../../

# Add the submodule reference update
git add packages/sage-libs/src/sage/libs/libamm
git commit -m "chore: update LibAMM submodule reference"
git push origin main-dev

Updating This Submodule

To pull latest changes from the submodule repository:

# In this directory
cd packages/sage-libs/src/sage/libs/libamm
git pull origin main-dev

# Update reference in main repo
cd ../../../../../
git add packages/sage-libs/src/sage/libs/libamm
git commit -m "chore: update LibAMM to latest"

Common Issues

❌ "fatal: Pathspec ... is in submodule"

Problem: You're in the main repository trying to commit submodule files.

Solution:

cd packages/sage-libs/src/sage/libs/libamm  # Enter the submodule first
git add .
git commit -m "your message"

❌ Changes not showing in main repository

Problem: You committed in the submodule but forgot to update the reference.

Solution:

cd ../../../../../  # Back to main repo
git add packages/sage-libs/src/sage/libs/libamm
git commit -m "chore: update LibAMM reference"

❌ "You are not currently on a branch"

Problem: Submodule is in detached HEAD state.

Solution:

cd packages/sage-libs/src/sage/libs/libamm
git checkout main-dev
git pull origin main-dev

Development Workflow

  1. Always work on the correct branch: main-dev
  2. Commit in submodule first, then update reference in main repo
  3. Push both repositories to share your changes
  4. Pull both repositories when updating

📚 For more details, see CONTRIBUTING.md

🤖 This file is auto-generated by tools/git-tools/generate-submodule-markers.sh