开源项目安装与配置指南：Git Conventional Commits

开源项目安装与配置指南：Git Conventional Commits

git-conventional-commits Git Conventional Commits Util to generate Semantic Version and Markdown Change Log and Validate Commit Messag 项目地址: https://gitcode.com/gh_mirrors/gi/git-conventional-commits

1. 项目基础介绍

Git Conventional Commits 是一个开源项目，主要用于帮助开发者生成符合约定式提交信息的 commit，进而自动化生成版本号和变更日志。该项目使用 JavaScript 编写，可以帮助改善项目的版本管理和文档工作流程。

2. 项目使用的关键技术和框架

• Node.js: 作为 JavaScript 的运行环境，Node.js 支持该工具的后端运行。
• YAML: 用于配置文件的格式，YAML 语言以数据做为中心，易于人类阅读和机器解析。
• Git Hooks: 通过 Git 的钩子（hooks）机制，在提交信息阶段对 commit 信息进行校验。
• Regex: 正则表达式用于匹配和验证 commit 信息格式。

3. 项目安装和配置的准备工作

在开始安装之前，请确保您的系统中已经安装了以下环境和工具：

• Node.js (推荐使用 LTS 版本)
• Git
• npm (Node.js 的包管理器)

详细安装步骤

步骤 1: 克隆项目仓库

打开终端或命令提示符，执行以下命令克隆项目仓库：

git clone https://github.com/qoomon/git-conventional-commits.git
cd git-conventional-commits

步骤 2: 安装依赖

在项目目录中，使用 npm 安装项目依赖：

npm install

步骤 3: 初始化配置文件

在项目目录中，运行以下命令来初始化配置文件模板：

npx git-conventional-commits init

根据提示，您可以对生成的 git-conventional-commits.yaml 文件进行自定义，以符合您的项目规范。

步骤 4: 设置 Git Hooks

为了在提交前自动验证 commit 信息，您需要设置 Git Hooks。这里有两种方法：

方法一：使用 pre-commit 框架

在项目根目录下创建 .pre-commit-config.yaml 文件，并添加以下内容：

repos:
  - repo: https://github.com/qoomon/git-conventional-commits
    rev: '<RELEASE_TAG>'
    hooks:
      - id: conventional-commits

然后安装 pre-commit：

pip install pre-commit

接着，安装 commit-msg hook：

pre-commit install -t commit-msg

方法二：手动设置 Commit Message Hook

首先，在您的项目目录中创建一个 .git-hooks 文件夹：

mkdir .git-hooks

然后，设置 Git config 来使用这个文件夹：

git config core.hooksPath .git-hooks

接下来，创建并配置 commit-msg 文件：

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

在 commit-msg 文件中添加以下脚本：

#!/bin/sh

# fix for windows systems
PATH="/c/Program Files/nodejs:$HOME/AppData/Roaming/npm/:$PATH"

npx git-conventional-commits commit-msg-hook "$1"

最后，将这个 commit-msg 文件添加到您的 Git 仓库中。

完成以上步骤后，您的项目就成功安装并配置了 Git Conventional Commits。现在，每次提交前，Git 都会自动校验您的 commit 信息是否符合预设的规范。

git-conventional-commits Git Conventional Commits Util to generate Semantic Version and Markdown Change Log and Validate Commit Messag 项目地址: https://gitcode.com/gh_mirrors/gi/git-conventional-commits