git提交限制规范

创建全局 Git Hook 配置文件

1. 创建安装脚本

创建一个文件 setup-global-git-hook.sh：

bash 复制代码

#!/bin/bash

# 创建全局 hooks 目录
GLOBAL_HOOKS_DIR="$HOME/.git-hooks"
mkdir -p "$GLOBAL_HOOKS_DIR"

# 创建 commit-msg hook 文件
cat > "$GLOBAL_HOOKS_DIR/commit-msg" << 'EOF'
#!/bin/bash

# 提交信息文件路径
commit_msg_file="$1"

# 读取提交信息
commit_msg=$(cat "$commit_msg_file")

# 定义允许的关键字
allowed_types="add|mod|fix|del|doc"

# 正则表达式：必须以 [关键字] 开头，后面至少跟一个空格和内容
pattern="^\[($allowed_types)\]\s+.+$"

# 检查提交信息是否符合规范
if ! echo "$commit_msg" | grep -qE "$pattern"; then
    echo ""
    echo "❌ 提交信息格式不符合规范！"
    echo ""
    echo "📝 格式要求：必须以以下关键字开头："
    echo "  [add] 新增功能"
    echo "  [mod] 修改功能"
    echo "  [fix] 修复问题"
    echo "  [del] 删除功能"
    echo "  [doc] 文档（sql、接口文档、readme等）"
    echo ""
    echo "✅ 正确示例："
    echo "  [add] 新增用户登录功能"
    echo "  [mod] 优化订单查询性能"
    echo "  [fix] 修复登录超时问题"
    echo "  [del] 移除过时的API接口"
    echo "  [doc] 更新接口文档"
    echo "  [doc] 添加数据库初始化sql"
    echo ""
    echo "❌ 错误示例："
    echo "  add 新增功能          (缺少方括号)"
    echo "  [add]新增功能         (缺少空格)"
    echo "  [update] 更新代码     (不允许的关键字)"
    echo ""
    exit 1
fi

exit 0
EOF

# 添加执行权限
chmod +x "$GLOBAL_HOOKS_DIR/commit-msg"

# 配置 Git 使用全局 hooks 目录
git config --global core.hooksPath "$GLOBAL_HOOKS_DIR"

echo ""
echo "✅ 全局 Git Hook 配置完成！"
echo "📁 Hook 目录：$GLOBAL_HOOKS_DIR"
echo ""
echo "现在所有 Git 仓库的提交信息都必须符合规范："
echo "  [add] 新增功能"
echo "  [mod] 修改功能"
echo "  [fix] 修复问题"
echo "  [del] 删除功能"
echo "  [doc] 文档（sql、接口文档、readme等）"
echo ""

2. 运行脚本

bash 复制代码

# 给脚本添加执行权限
chmod +x setup-global-git-hook.sh

# 运行脚本
./setup-global-git-hook.sh

或者直接手动配置

如果你想手动配置，执行以下命令：

bash 复制代码

# 1. 创建全局 hooks 目录
mkdir -p ~/.git-hooks

# 2. 创建 commit-msg 文件
cat > ~/.git-hooks/commit-msg << 'EOF'
#!/bin/bash

commit_msg_file="$1"
commit_msg=$(cat "$commit_msg_file")

pattern="^\[(add|mod|fix|del|doc)\]\s+.+$"

if ! echo "$commit_msg" | grep -qE "$pattern"; then
    echo ""
    echo "❌ 提交信息格式不符合规范！"
    echo ""
    echo "格式要求：必须以 [add]、[mod]、[fix]、[del]、[doc] 开头"
    echo "示例："
    echo "  [add] 新增用户登录功能"
    echo "  [mod] 优化订单查询性能"
    echo "  [fix] 修复登录超时问题"
    echo "  [del] 移除过时的API接口"
    echo "  [doc] 更新接口文档"
    echo ""
    exit 1
fi

exit 0
EOF

# 3. 添加执行权限
chmod +x ~/.git-hooks/commit-msg

# 4. 配置 Git 使用全局 hooks
git config --global core.hooksPath ~/.git-hooks

echo "✅ 全局配置完成！"

验证配置

配置完成后，可以测试一下：

bash 复制代码

# ✅ 正确的提交（会成功）
git commit -m "[add] 新增用户登录功能"

# ✅ 正确的提交
git commit -m "[doc] 更新README文档"

# ✅ 正确的提交
git commit -m "[fix] 修复登录bug"

# ❌ 错误的提交（会被拒绝）
git commit -m "add 新增功能"           # 缺少方括号
git commit -m "[add]新增功能"          # 缺少空格
git commit -m "[update] 更新代码"      # 不允许的关键字

注意事项

全局配置生效范围：这个配置会对你电脑上所有 Git 仓库生效
绕过检查 ：如果需要紧急跳过检查，可以使用 git commit --no-verify -m "message"，但建议只在特殊情况下使用
团队协作：如果团队成员也需要此规范，可以把这个脚本分享给他们执行

这样配置后，任何不符合 [add]、[mod]、[fix]、[del]、[doc] 开头的提交都会被拒绝。