Conventional Commits 规范

4 min read

Conventional Commits 是一种编写清晰、结构化和易于管理的提交消息的约定规范。它鼓励开发人员使用一致的语法和格式来描述提交的内容，以便更容易理解和追踪代码变更。

以下是 Conventional Commits 规范的主要要点：

  1. 提交消息的结构：每个提交消息由三个部分组成，分别是类型、影响范围和主题：

    <类型>(<影响范围>): <主题>

  2. 类型(Type)：表示代码变更的种类，可以是如下之一：

    • feat：新增功能
    • fix：修复 bug
    • docs：文档的变更
    • style：代码样式的变更（不影响功能）
    • refactor：代码的重构
    • test：添加或修改测试代码
    • chore：构建过程或辅助工具的变更

  3. 影响范围：表示此次提交的变更影响的范围，可以是任何与代码库相关的内容，如模块、文件、功能等。

  4. 主题：简洁、有意义的描述本次提交的内容。

  5. 具体规范约定了一些常用的关键词，如：BREAKING CHANGE（重大变更）和CLOSES（关闭某个问题）。

采用 Conventional Commits 规范的好处是增加了提交历史的可读性和可维护性，方便了代码审查和追踪问题。还可以通过工具生成 ChangeLog 和版本号等文档和标签，帮助团队更好地管理和协作开发。