Conventional Commits 使用教程

Conventional Commits 使用教程

conventional-commits:yo_yo: A PHP library for creating and validating commit messages according to the Conventional Commits specification. Includes a CaptainHook plugin!项目地址:https://gitcode.com/gh_mirrors/co/conventional-commits

项目介绍

Conventional Commits 是一种轻量级的提交信息规范，旨在为创建明确的提交历史提供一套简单的规则。这种规范有助于自动化工具理解提交的意图，例如自动生成 CHANGELOG 或确定版本升级。Conventional Commits 规范通过定义一种标准的提交消息格式，使得提交信息更加结构化和易于理解。

项目快速启动

安装

首先，你需要安装 conventional-commits 工具。你可以通过以下命令进行安装：

npm install @commitlint/cli @commitlint/config-conventional --save-dev

配置

安装完成后，你需要在项目根目录下创建一个配置文件 commitlint.config.js，内容如下：

module.exports = {
  extends: ['@commitlint/config-conventional'],
};

使用

在提交代码时，确保你的提交消息遵循 Conventional Commits 规范。例如：

git commit -m "feat: add new feature"

应用案例和最佳实践

应用案例

Conventional Commits 广泛应用于各种开源项目中，特别是在需要自动化版本管理和 CHANGELOG 生成的项目中。例如，Angular 项目就采用了这种规范，使得其提交历史清晰且易于维护。

最佳实践

1. 明确类型：在提交消息中明确指定提交类型，如 feat、fix、docs 等。
2. 简洁描述：提交消息的描述应简洁明了，避免冗长和不必要的细节。
3. 关联问题：如果提交与某个问题相关，应在提交消息中提及该问题编号，如 fix #123。

典型生态项目

Conventional Commits 规范与多个生态项目紧密结合，以下是一些典型的生态项目：

1. Commitlint：用于检查提交消息是否符合 Conventional Commits 规范的工具。
2. Standard Version：一个自动化版本管理和 CHANGELOG 生成的工具，依赖于 Conventional Commits 规范。
3. Husky：一个 Git Hook 工具，可以在提交代码前执行脚本，确保提交消息符合规范。

通过这些工具的配合使用，可以大大提高项目的可维护性和协作效率。

conventional-commits:yo_yo: A PHP library for creating and validating commit messages according to the Conventional Commits specification. Includes a CaptainHook plugin!项目地址:https://gitcode.com/gh_mirrors/co/conventional-commits