如何在复刻仓库中管理子模块，避免拉取请求冲突？

我正在处理两个仓库：Library和Project1，当前配置如下：

1. 仓库情况：
   • 已复刻Library和Project1，创建了Library.myfork和Project1.myfork。
   • Project1.myfork被作为子模块添加到Library.myfork的examples/目录下。
2. 目录结构：
   Library.myfork/的目录结构如下：

Library.myfork/
├── examples/
│   └── Project1.myfork/ (submodule pointing to Project1.myfork)
├── src/
├── README.md
└── ...

3. 问题：
   • 向Library.myfork推送变更时，提交内容包含examples/Project1.myfork的子模块引用及其变更。
   • 从Library.myfork向原Library仓库发起拉取请求（PR）时，会因其他开发者添加了自己的Project1复刻作为子模块（如Project1.theirfork）而产生冲突，导致子模块指针及相关文件出现冲突。
4. 已尝试方案：
   • 将examples/Project1加入.gitignore，但无法解决子模块引用问题。
   • 寻找子模块的替代方案（如subtrees），但不确定其对向主Library仓库发起PR的影响。

请问如何在不引发拉取请求冲突的情况下管理该配置？具体包括：

• 如何在Library.myfork的examples/目录中包含Project1.myfork，且不影响向主Library仓库发起的PR？
• 是否有比子模块更好的方式，在复刻仓库中包含并更新依赖项目？

一、避免子模块影响PR的具体操作 #

核心思路是不让子模块的引用文件进入提交PR的分支，具体可采用以下两种方式：

1. 分离开发分支与PR分支
   • 创建专属本地开发分支（比如dev-with-submodule），在该分支中添加并维护Project1.myfork子模块，日常开发调试都基于此分支。
   • 需发起PR时，基于主分支（如main）新建功能分支（如feature/new-function），仅将Library.myfork中src/、README.md等核心代码的变更，通过cherry-pick或合并同步到这个功能分支，完全排除examples/Project1.myfork子模块相关文件（包括.gitmodules、子模块指针文件）。
   • 用这个干净的功能分支提交PR，就能彻底避免和其他开发者的子模块配置冲突。
2. 临时移除子模块后提交PR
   • 若不想维护多分支，可在提交PR前临时移除子模块：

     # 暂存当前工作区变更
     git stash
     # 移除子模块
     git submodule deinit -f examples/Project1.myfork
     rm -rf .git/modules/examples/Project1.myfork
     git rm -f examples/Project1.myfork
     # 提交移除子模块的临时变更（仅用于PR）
     git commit -m "temp remove submodule for PR"
     # 推送PR分支并发起请求
     git push origin pr-branch
     # 恢复子模块
     git stash pop
     git submodule update --init --recursive
     

   这种方式适合临时处理PR，缺点是每次提交PR都需要重复操作。

二、子模块的替代方案 #

1. Git Subtree #

Git Subtree可将Project1.myfork的代码直接合并到Library.myfork的examples/目录，而非使用引用指针：

• 添加子树：

  git remote add project1-fork <你的Project1.myfork仓库URL>
  git subtree add --prefix examples/Project1.myfork project1-fork main --squash
  

• 更新子树：

  git subtree pull --prefix examples/Project1.myfork project1-fork main --squash
  

• 提交PR时，同样只提交Library核心代码的变更，不包含子树合并的内容。若主仓库允许示例代码合并，也可单独提交子树变更，但需注意其他开发者的子树仍可能引发冲突，因此核心原则还是PR分支只保留自己的Library修改。

2. 手动克隆+Git忽略 #

放弃子模块/子树，手动将Project1.myfork克隆到Library.myfork/examples/目录，再将该目录加入.gitignore：

# 在Library.myfork目录下执行
git clone <你的Project1.myforkURL> examples/Project1.myfork
echo "examples/Project1.myfork/" >> .gitignore
git add .gitignore
git commit -m "ignore local project1 fork"

这种方式最简洁，本地更新Project1.myfork时，直接进入该目录拉取代码即可，PR时完全不会涉及依赖项目内容，从根源避免冲突。

3. Git Worktree #

用Git Worktree将Project1.myfork作为独立工作树挂载到Library.myfork/examples/目录：

# 在Library.myfork目录下执行
git worktree add examples/Project1.myfork <你的Project1.myfork仓库URL> main

此时examples/Project1.myfork是独立Git仓库，不会与Library.myfork的提交绑定，同样将该目录加入.gitignore，PR时就不会包含相关内容，本地更新时直接进入该目录操作即可。

内容的提问来源于stack exchange，提问作者yadhu