cz-conventional-changelog-zh-cn

# Conventional Chanagelog 提交类型说明 ## 类型说明 ### feat **描述：** 添加新功能或功能性变化。 **示例：** - feat: 添加用户身份验证功能 - feat: 实现新的用户界面 - feat: 增加对多语言支持的功能 ### fix **描述：** 修复 bug。 **示例：** - fix: 修复登录页面无法加载的问题 - fix: 修正数据保存时的错误 ### docs **描述：** 仅文档变更。 **示例：** - docs: 更新安装说明 - docs: 修改 API 文档 ### style **描述：** 不影响代码运行的代码样式变更（例如空白符，格式化，分号等）。 **示例：** - style: 格式化代码缩进 - style: 调整 CSS 样式 ### refactor **描述：** 重构代码，既不新增功能，也不是修复 bug。例如修改代码结构、变量名、函数名等但不修改功能逻辑。 **示例：** - refactor: 重构用户管理模块 - refactor: 优化数据存储结构 ### perf **描述：** 提升性能的代码变更。例如提升代码的性能、减少内存占用等。 **示例：** - perf: 优化搜索算法 - perf: 加速数据加载过程 ### test **描述：** 增加或修改测试用例。 **示例：** - test: 新增用户注册表单测试 - test: 更新数据验证测试 ### build **描述：** 对构建过程或构建依赖的变更（范围示例：gulp、broccoli、npm）。例如修改依赖库、外部接口或者升级 Node 版本等。 **示例：** - build: 更新构建脚本以适配新的部署环境 - build: 增加 Docker 镜像构建配置文件 - build: 升级 Node 版本 - build: 更新外部依赖 ### ci **描述：** 对持续集成（CI）相关配置文件或脚本的变更（范围示例：Travis、Circle）。例如修改 Travis、Jenkins 等工作流配置。 **示例：** - ci: 更新持续集成配置以适配新的测试环境 - ci: 调整构建脚本以并行执行测试任务 - ci: 修改 Travis，Jenkins 等工作流配置 ### chore **描述：** 未对源（src）代码与测试（test）文件进行变更的其他变更。 **示例：** - chore: 更新构建脚本以适配新的部署环境 - chore: 清理无用的依赖项 > build 类型的提交更专注于与项目构建和部署流程相关的修改，而 chore 类型则更广泛，包括了项目开发、维护过程中的各种辅助性变更，可以理解为非源码（src）与测试（test）的修改。 ### revert **描述：** 恢复之前的提交。 **示例：** - revert: Revert "feat: 添加用户身份验证功能" - revert: Revert "fix: 修复登录页面无法加载的问题" ## 类型感叹号格式说明 **描述：** 类型后面紧跟着感叹号以提醒注意破坏性变更或重要性变更的提交说明。 **示例：** - feat!: 新增了登录验证码功能 - docs!(readme): 更新软件新功能的使用方式 ## BREAKING CHANGE 破坏性变更说明 > 破坏性变更可以是任意 **类型** 提交的一部分。 **描述：** BREAKING CHANGE 用于指示对现有功能或 API 的重大变更，这些变更将可能导致现有用户的代码、配置或行为出现兼容性问题。 BREAKING CHANGE 应该在提交消息的正文部分使用，并且应该按照一定的格式进行描述，以便清晰地传达变更的内容和影响。通常，它的格式如下： **格式：** ``` BREAKING CHANGE: <描述变更的简要说明> <变更的详细描述，包括对现有功能、API 或行为的修改，以及可能的影响和需要采取的新措施> ``` **示例：** ``` feat: 添加新的 API 接口 BREAKING CHANGE: 修改了现有用户验证逻辑，现在需要提供额外的参数来进行认证。 ``` ## 参考更多详细参考 [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)