代码提交规范

以下为你介绍代码提交规范及最佳实践，涵盖提交信息格式、提交频率、分支管理、代码审查等核心环节：

一、提交信息规范

1. 格式模板

   复制代码<类型>(<范围>): <简短描述><详细描述>

• feat：新功能

• fix：修复Bug

• docs：文档变更

• style：代码格式调整（不影响逻辑）

• refactor：代码重构

• perf：性能优化

• test：测试代码变更

• chore：构建或工具调整

• 类型：标识提交类别（必填），常用类型包括：

• 范围：可选，用括号注明影响模块（如auth、login）。

• 简短描述：简明扼要（50字符内），使用祈使句（如添加登录接口）。

• 详细描述：可选，解释变更原因、解决方案或关联Issue（如修复用户登录空指针异常，关闭#123）。

2. 示例

   复制代码feat(auth): 添加JWT认证接口新增基于JWT的用户认证接口，支持令牌生成与校验，提升系统安全性。

二、提交频率与原则

1. 小步提交

• 每次提交聚焦单一逻辑变更，避免“大杂烩”提交。

• 示例：修复一个Bug时，提交信息明确为fix(login): 修复验证码过期问题，而非合并其他无关修改。

2. 功能完整性

• 确保提交的代码可独立运行，避免提交“半成品”。

3. 定期提交

• 完成功能模块或解决特定问题后及时提交，避免代码堆积。

三、分支管理策略

1. 常用分支类型

• 主分支（main/master）：仅合并稳定代码，直接关联生产环境。

• 开发分支（develop）：日常开发主战场，新功能和修复优先提交至此。

• 功能分支（feature/xxx）：每个新功能独立分支开发，命名如feature/user-profile。

• 发布分支（release/xxx）：准备发布时从develop创建，用于最终测试和调整。

• 修复分支（hotfix/xxx）：紧急修复线上问题，从main创建，修复后合并回main和develop。

2. 操作流程

   mermaid复制代码graph TDA[主分支 main] --> B[开发分支 develop]B --> C[功能分支 feature/xxx]C -->|合并| BB --> D[发布分支 release/xxx]D -->|发布| AA --> E[修复分支 hotfix/xxx]E -->|修复| AE -->|同步| B

四、代码审查规范

1. 审查流程

• 自查：提交前检查代码风格、基础逻辑、测试用例。

• 触发审查：通过Pull Request（PR）提交代码，指定审查人。

• 反馈与修改：审查人提出具体建议（如“变量名tmp需改为有意义的名称”），开发者修改后更新PR。

• 复审与合并：审查人确认无误后批准合并。

2. 审查工具

• SonarQube：自动化检测代码质量、安全漏洞。

• Checkstyle/PMD：检查代码风格与潜在问题。

五、代码风格规范

1. 命名规范

• 变量/函数：小驼峰（userName），避免无意义名称（如a, b）。

• 类名：大驼峰（UserController）。

• 常量：全大写+下划线（MAX_RETRIES）。

2. 缩进与格式

• 统一使用4空格或2空格（团队需约定），避免Tab与空格混用。

• 代码格式化工具（如Prettier、Black）自动处理。

3. 注释规范

• 解释“为什么”而非“是什么”：如// 使用快速排序优化性能。

• 避免冗余注释：代码应自解释，复杂逻辑需注释。

六、自动化工具集成

1. Git Hooks

• 提交前自动运行单元测试、代码格式化（如pre-commit钩子）。

2. CI/CD流水线

• 代码提交后触发自动化测试、构建、部署（如Jenkins、GitHub Actions）。

3. 代码质量平台

• SonarQube集成到CI流程，阻断质量未达标的代码合并。

七、规范执行要点

1. 团队共识

• 制定规范文档，全员培训，定期复盘。

2. 工具辅助

• 使用Lint工具、Git模板强制规范。

3. 持续优化

• 根据项目需求调整规范（如开源项目需兼容社区标准）。

遵循上述规范，可显著提升代码可维护性、团队协作效率，减少后期维护成本。