如何让Git子模块中的pull_request_template.md在Pull Request时生效？

核心思路 #

Azure DevOps原生不支持直接读取子模块中的pull_request_template.md，所以可以用**Git钩子（Git Hooks）**实现自动同步子模块里的模板到主仓库根目录，让ADO能识别并自动加载模板。

具体步骤 #

1. 配置post-checkout钩子同步模板 #

在主仓库的.git/hooks目录下新建post-checkout文件（若已存在则覆盖内容），添加以下脚本：

#!/bin/bash

# 替换为你的子模块实际路径
SUBMODULE_PATH="your-submodule-dir"
TEMPLATE_SOURCE="${SUBMODULE_PATH}/pull_request_template.md"
TARGET_PATH="./pull_request_template.md"

# 初始化并更新子模块
git submodule update --init --recursive

# 同步模板文件到主仓库根目录
if [ -f "$TEMPLATE_SOURCE" ]; then
    cp "$TEMPLATE_SOURCE" "$TARGET_PATH"
    echo "已同步子模块PR模板到主仓库根目录"
else
    echo "子模块中未找到pull_request_template.md文件"
fi

2. 给钩子添加执行权限 #

在终端执行命令赋予脚本可执行权限：

chmod +x .git/hooks/post-checkout

3. 可选：配置pre-push钩子确保模板最新 #

如果担心切换分支后模板未同步，可以再创建pre-push钩子，推送前自动同步最新模板：

#!/bin/bash

SUBMODULE_PATH="your-submodule-dir"
TEMPLATE_SOURCE="${SUBMODULE_PATH}/pull_request_template.md"
TARGET_PATH="./pull_request_template.md"

# 更新子模块到最新版本
git submodule update --remote "$SUBMODULE_PATH"

# 同步并提交模板变更
if [ -f "$TEMPLATE_SOURCE" ]; then
    cp "$TEMPLATE_SOURCE" "$TARGET_PATH"
    git add "$TARGET_PATH"
    git commit -m "Sync PR template from submodule" --no-verify
fi

同样给该钩子添加执行权限：

chmod +x .git/hooks/pre-push

额外说明 #

• Git钩子默认不会被仓库追踪，建议把钩子脚本放到主仓库的可追踪目录（比如scripts/git-hooks），然后通过以下命令让Git使用该目录的钩子：

  git config core.hooksPath scripts/git-hooks
  

  团队成员克隆仓库后，只需执行上述配置命令就能复用钩子。
• 子模块更新后，钩子会自动同步模板，确保所有PR都使用最新的模板内容。

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