Skip to main content

代码提交规范

git 提交说明

git 的提交说明分为三部分：Header、Body、Footer。

  1. Header 的格式时：<type>(scope): <subject>

    • type: commit 的提交性质，例如 feat、fix、docs、chore 等
    • scope：非必填，用于说明 commit 的影响范围
    • subject：commit 的简短描述

  2. Body 是 commit 的详细描述

  3. 如果提交是BREAKING CHANGE，或者是针对特定的 issue，则需要填写 Footer。

集成 Commitizen 实现规范提交

Commitizen 是一个帮助撰写规范 commit message 的工具。具体使用可以看Cz 工具集使用介绍 - 规范 Git 提交说明

changelog

在开源项目中经常会看到 changelog，记录了项目版本迭代的信息。使用conventional-changelog，结合 Commitizen，可以生成项目的 changelog。

npm publish

使用np，进行版本发布。配合 npm 的 prepublishOnly 钩子使用。

参考文章： Cz 工具集使用介绍 - 规范 Git 提交说明

从零到一，带你搭建 Vue3 企业级大型项目前端工作流