Appearance
3.2 代码管理
在企业级后台系统中，代码管理是保障多人协作、提升交付质量与维护长期可读性的关键环节。相比 C 端产品强调快速迭代，B 端更注重版本控制、提交规范、代码审查和权限管理。
本文主要围绕 Git 分支策略、提交规范、代码审查机制、权限控制等方面展开，适用于使用 Git + PR 流程 + CI/CD 的开发团队。
一、Git 分支策略
建议采用适合企业级项目的分支管理方式，推荐以下两种主流模型：
1. GitHub Flow（轻量级推荐）
- 主分支：main
- 所有功能都通过 feature 分支开发并发起 PR
- 合并后自动部署到测试或生产环境
示例流程：
- 开发新功能时创建
feature/user-profile-edit - 完成后发起 PR 到 main
- 审核通过后合并，并触发部署流程
2. GitLab Flow（支持多环境发布）
- 类似 GitHub Flow，但支持环境分支（如
staging/prod） - 更好地支持灰度发布与多阶段验证
示例分支命名：
- main
- staging
- feature/user-list-sort
- bugfix/login-issue
- release/v1.2.0
二、提交规范（Commit Message）
统一的提交规范有助于追踪变更历史、生成 CHANGELOG、定位 Bug 来源。
推荐规范：Conventional Commits
格式如下：
<type>(<scope>): <subject>
<body>
<footer>说明：
<type>：提交的类型，如 feat（新增功能）、fix（修复 Bug）、chore（构建流程更新）等；<scope>（可选）：修改范围，例如模块名或文件名；<subject>：简短描述本次提交的目的；<body>：详细描述更改内容，包括解决的问题和实现方式；<footer>：用于引用相关 Issue 或 Breaking Change 声明；
常见 type 类型：
| Type | 描述 |
|---|---|
| feat | 新增功能 |
| fix | 修复 Bug |
| chore | 构建流程或工具相关更新 |
| docs | 文档更新 |
| style | 样式调整 |
| refactor | 重构代码 |
| perf | 性能优化 |
| test | 测试相关 |
| build | 构建系统相关 |
| ci | CI/CD 相关 |
| revert | 回滚提交 |
示例：
feat(auth): add phone login support
- Add new login method with SMS verification
- Update auth service to handle phone token
BREAKING CHANGE: Auth API now requires phone or email for login三、代码审查机制（Code Review）
代码审查是保障代码质量的重要手段，建议在每次 PR（Pull Request）合入前进行。
1. Code Review 关注点
- 是否符合编码规范？
- 是否存在潜在 Bug 或边界条件未处理？
- 是否影响其他模块功能？
- 是否添加必要的测试用例？
- 是否有性能问题或内存泄漏？
2. 审查流程建议
- 提交 PR 时填写清晰的描述和截图（如有 UI 变更）；
- 至少一位同事进行 Review；
- 使用 GitHub/GitLab 的评论功能提出修改建议；
- 支持“Approve”、“Request Changes”、“Comment Only”三种状态；
- 合并前确保 CI 构建通过、测试覆盖率达标；
3. 自动化辅助工具
- CI 检查：自动运行 ESLint、Prettier、TypeScript 编译、单元测试；
- LintBot：PR 中自动提示格式错误；
- Coverage Report：显示新增代码的测试覆盖率；
- Dependency Check：检查依赖安全性漏洞；
四、权限与保护机制
1. 分支保护规则（Branch Protection）
- 设置 main 和 release 分支为只读，仅允许通过 PR 合并；
- 强制要求 Code Review + CI 通过后才可合并；
- 禁止强制 Push；
- 合并方式限制为
Merge Commit或Squash and Merge；
2. 访问控制
- 按角色设置仓库访问权限（开发者、维护者、管理员）；
- 敏感分支（如 main）仅限核心成员操作；
- 使用 SSH 密钥或 Personal Access Token 进行身份验证；
五、常用命令与工具推荐
Git 常用命令
bash# 查看当前分支状态 git status # 创建并切换到新分支 git checkout -b feature/new-ui # 添加文件并提交 git add . git commit -m "feat(ui): update login page layout" # 推送到远程仓库 git push origin feature/new-ui # 拉取最新代码并合并 git pull origin develop
2. Git 工具推荐
| 工具名称 | 特点 |
|---|---|
| VSCode 内置 Git | 快速查看改动、提交、推送、对比 |
| SourceTree | 图形化界面，可视化分支和提交历史 |
| GitKraken | 支持跨平台，提供高级分支管理和协作功能 |
| gitmoji | 使用表情符号增强 Commit Message 可读性 |