如何规范git commit的提交记录

2024-01-05 04:45:09

格式 1: add: 添加...

这种格式是git commit中最基本也是最常见的格式之一。它由两部分组成：add和添加的内容。add表示添加文件或目录到git版本库中，而添加的内容可以是文件路径、通配符或正则表达式。

例如，以下commit记录表示将src/main/java目录下的所有Java文件添加到git版本库中：

add: src/main/java/*.java

格式 2: [add]: 添加...

这种格式与格式1类似，但它在add前面添加了方括号[]。方括号表示该commit记录属于一个系列，通常用于跟踪一个功能或任务的进展。

例如，以下commit记录表示将src/main/java/com/example/myapp目录下的所有Java文件添加到git版本库中，并且属于“feature/new-feature”系列：

[feature/new-feature]: add: src/main/java/com/example/myapp/*.java

格式 3: Add 添加...

这种格式与格式1类似，但它将add改为了Add，并且将添加的内容放在了Add后面。这种格式更符合英语表达习惯，也更易于阅读。

例如，以下commit记录表示将src/main/resources目录下的所有配置文件添加到git版本库中：

Add src/main/resources/*.properties

交互式生成 commit 记录

除了上述三种常见格式外，还可以通过自定义npm脚本交互式生成commit记录。这可以简化提交记录的编写过程，并确保提交记录的规范性。

以下是一个示例npm脚本，用于交互式生成commit记录：

#!/bin/bash

# 获取要提交的文件或目录
files=$(git diff --cached --name-only)

# 循环遍历要提交的文件或目录
for file in $files; do
  # 提示用户输入提交记录
  echo "Enter a commit message for $file:"
  read commit_message

  # 将提交记录添加到git版本库中
  git add $file
  git commit -m "$commit_message"
done