代码日志提交规范

在版本控制中，日志、分支以及与之相关的操作类型（如build、refactor等）是代码管理和协作开发中的重要概念。以下是一些常见的类型及其说明：

日志类型

• feat：新增功能，例如feat: 增加用户注册功能。
• fix：修复bug，例如fix: 修复登录页面崩溃的问题。
• docs：文档变更，例如docs: 更新README文件。
• style：代码风格变动，不影响代码逻辑，例如style: 删除多余的空行。
• refactor：代码重构，既不是新增功能也不是修复bug的代码更改，例如refactor: 重构用户验证逻辑。
• perf：性能优化，例如perf: 优化图片加载速度。
• test：添加或修改测试，例如test: 增加用户模块的单元测试。
• chore：构建过程或辅助工具的变动，例如chore: 更新依赖库。
• build：构建系统或外部依赖项的变更，例如build: 升级webpack到版本5。
• ci：持续集成配置的变更，例如ci: 修改GitHub Actions配置文件。
• revert：回滚之前的提交，例如revert: 回滚feat: 增加用户注册功能。

分支类型

• 主分支
  • main或master：项目的主分支，存放正式发布的版本。
  • develop：开发分支，用于日常开发阶段验证新功能。
• 功能性分支
  • feature/<版本>/<功能>：用于开发新功能的分支，例如feature/v1.0.0/authentication。
  • fix/<版本>/<问题描述>：修复特定版本中的错误，例如fix/v1.0.0/login。
  • 其他类型名：docs、refactor、test等。
• 特定目的或临时性分支
  • release/<版本>：用于准备发布的版本，允许进行最后的调整，例如release/v1.0.0。
  • hotfix/<版本>/<问题描述>：用于紧急修复生产环境中的问题，例如hotfix/v1.0.0/payment。
• 个人或团队工作分支
  • <用户>/<类型>/<版本>/<描述>：个人工作分支，明确指出负责人和工作内容，例如john/fix/v1.0.0/login-issue。
  • team/<团队>/<类型>/<版本>/<描述>：团队工作分支，有助于区分不同团队的工作，例如team/account/feature/v1.0.0/add-nickname。

示例

• 日志示例
  • feat: 新增用户登录功能
  • refactor: 重构用户验证逻辑
  • build: 升级webpack到版本5
• 分支示例
  • feature/v1.0.0/new-login
  • hotfix/v1.0.0/fix-login-crash
  • john/refactor/v1.0.0/clean-code

这些规范有助于保持代码库的整洁和可维护性，同时提高团队协作的效率。