仓库如何配置代码提交规则

下面是一个关于 Git 提交消息规范及其验证脚本的配置和说明文档，可以用于向团队成员说明如何使用该规范和脚本。

Git 提交消息规范及验证脚本说明文档

目的

为了提高代码提交的可读性和可维护性，我们采用统一的提交消息规范。通过规范化的提交消息，团队成员能够快速理解每次提交的目的和内容。

提交消息规范

我们遵循 Conventional Commits 的格式，提交消息结构如下：

1
2
3
4
5
< 类型 >[可选的范围]: < 描述 >

[可选的正文]

[可选的页脚]

类型

  • feat：新功能
  • fix：修复 bug
  • docs：文档更改
  • style：格式更改（不影响代码运行的更改）
  • refactor：代码重构
  • perf：性能优化
  • test：添加测试
  • chore：其他变更（构建过程或辅助工具的变更）

范围（可选）

表示影响的模块或功能，例如 auth、ui 等。

描述

简短明了地描述变更，建议长度在 1 到 50 个字符之间。

示例

1
2
3
4
5
feat(auth): add JWT authentication

Implement JSON Web Token authentication for user login.

Closes #42

提交消息验证脚本

为了确保所有提交消息符合上述规范，我们提供了一个 Git Hook 脚本，名为 commit-msg。该脚本会在每次提交时自动运行，检查提交消息格式是否正确。

脚本内容

以下是 commit-msg 脚本的内容：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
#!/bin/sh

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

# 正则表达式匹配
pattern='^(feat|fix|docs|style|refactor|perf|test|chore)(\([a-zA-Z0-9_-]+\))?: .{1,50}'

if ! echo "$commit_msg" | grep -qE "$pattern"; then
    echo " 提交消息格式错误!"
    echo " 请使用规范格式: < 类型 >(< 范围 >): < 描述 >"
    echo " 例如: feat(auth): add JWT authentication"
    exit 1
fi

如何配置 Git Hook

  1. 创建 Git Hook 文件 ：
    在项目的 .git/hooks 目录下创建 commit-msg 文件。

    1
    2
    touch .git/hooks/commit-msg
    chmod +x .git/hooks/commit-msg

  2. 添加脚本内容 ：
    将上述脚本内容复制并粘贴到新创建的 commit-msg 文件中。

  3. 保存并退出 ：
    保存文件并退出编辑器。

使用说明

  • 当您在项目中进行代码提交时，Git 会自动执行 commit-msg 脚本。
  • 如果提交消息不符合规范，脚本将会输出错误信息，并阻止提交。

注意事项

  • 请确保在每次提交之前，您的提交消息符合规范。
  • 如果您对提交消息格式有任何疑问，请随时与团队其他成员沟通。

通过遵循上述规范和使用提供的验证脚本，您将帮助团队保持代码库的整洁和可维护性。感谢您的配合与支持！

希望这份文档能够帮助您的团队理解和使用 Git 提交消息规范及验证脚本。如果有任何问题，请随时反馈。