git-commit-analytics 分析Git Commit记录生成工作日报

本文最后更新于 2 年 10 个月前，部分内容可能不适合当前所有情况，仅供参考。

一个可以分析你的 Git 仓库 commit 记录的工具。它可以帮你生成一份工作日报 / 周报，或者你需要的更长时间范围的工作报告。

客户端下载

这是一个客户端工具，所以你需要下载程序去使用它，点击 最新版本 去下载客户端。

更新记录

你可以查看 更新记录 去了解每个版本的更新内容。

使用说明

创建并填写你的配置文件，然后运行程序，即可获得你的工作报告。

配置文件

你需要在与程序相同的文件夹下，创建一个名为 config.json 的文件，并写入以下格式的内容。

{
  "lang": "en",
  "authors": ["chengpeiquan"],
  "dateRange": ["2021-12-01", "2022-01-31"],
  "repos": ["D:\\Git\\git-commit-analytics"],
  "format": {
    "git-commit-analytics": "Git Commit Analytics"
  },
  "includes": ["feat", "fix", "docs", "style", "refactor", "test", "chore"],
  "excludes": ["typo", "backup", "progress"]
}

配置项说明如下：

Among them, authors / includes / excludes will be created as regular expressions to match data.

其中，authors / includes / excludes 会创建为正则表达式去匹配数据。

工作报告

The report file will be generated in markdown syntax (probably the most common format for developer?) and saved as a file in .txt format (probably the most compatible format?).

报告文件会以 markdown 语法生成（可能是对程序员最通用的格式？），并以 .txt 格式的文件保存（可能是兼容性最好的格式？）。

The project name will be classified as the second-level title, and 7 types of commit prefixes will be classified as the third-level title:

会以项目名称作为二级标题归类，以 7 个类型的 commit 前缀作为三级标题归类：

你可以点击 Commit message 和 Change log 编写指南 学习如何规范化提交 Git Commit 。