我是如何规整commit信息来提高团队工作效率的

前端

2023-11-30 03:45:55

作为一个项目的维护者，我深深地明白一个规范的 commit 信息是多么的重要。它不仅让代码看起来赏心悦目，而且也能够在后期出现问题时，快速地排查到对应的代码。

在本文中，我将与你分享我是如何通过使用 Git hooks 来规范 commit 信息的，以及如何将这种规范集成在你的项目中。

使用 `Git hooks` 规范 `commit` 信息

Git hooks 是一个很强大的工具，它允许你在特定的事件发生时执行特定的脚本。在我们的案例中，我们可以使用 Git hooks 来在 commit 发生之前检查 commit 信息是否符合我们的规范。

要使用 Git hooks，首先你需要创建一个 .git/hooks 目录，如果没有，就创建一个。然后，你可以将你要执行的脚本放在这个目录下。

对于 commit 规范，我们可以创建一个名为 pre-commit 的脚本。这个脚本会在 commit 发生之前执行，如果 commit 信息不符合我们的规范，它就会阻止 commit 的发生。

以下是 pre-commit 脚本的一个示例：

#!/bin/bash

# 检查 commit 信息是否为空
if [ -z "$1" ]; then
  echo "Commit 信息不能为空。"
  exit 1
fi

# 检查 commit 信息是否以大写字母开头
if [[ ! "$1" =~ ^[A-Z] ]]; then
  echo "Commit 信息必须以大写字母开头。"
  exit 1
fi

# 检查 commit 信息是否包含标点符号
if [[ "$1" =~ [!"#$%&'()*+,./:;<=>?@[\]^_`{|}~] ]]; then
  echo "Commit 信息不能包含标点符号。"
  exit 1
fi

# 检查 commit 信息是否超过 50 个字符
if [[ ${#1} -gt 50 ]]; then
  echo "Commit 信息不能超过 50 个字符。"
  exit 1
fi

# 检查 commit 信息是否包含脏字
if [[ "$1" =~ [fuck|shit|damn|asshole|bitch] ]]; then
  echo "Commit 信息不能包含脏字。"
  exit 1
fi