Skip to main content

团队协作 | Team Collaboration

欢迎加入 Project Team!本文档将帮助你快速了解我们的开发流程和协作规范。
所有代码变更必须通过 Pull Request 进行审核,确保代码质量和团队协作的一致性。

📋 开发流程 | Development Workflow

Git 工作流

我们采用 Git Flow 工作流,确保代码变更的可追溯性和稳定性。
1

创建功能分支

main 分支创建新的功能分支:
2

开发与提交

进行开发工作,并遵循我们的提交规范:
3

创建 Pull Request

将你的分支推送到远程仓库,并创建 Pull Request 等待审核。
4

代码审核

团队成员将审核你的代码,提出建议或批准合并。

📝 提交规范 | Commit Convention

我们遵循 Conventional Commits 规范:

提交类型

🔄 Pull Request 规范

PR 标题格式

示例:
  • feat: 添加 Helm Chart 支持
  • fix: 修复资源配额配置错误
  • docs: 完善 YAML 部署指南

PR 描述模板

🛡️ 代码审核 | Code Review

审核清单

在提交 PR 前,请确保:
  • 代码符合项目规范
  • 已通过本地测试
  • 文档已更新(如需要)
  • 提交信息符合规范
  • 没有引入安全漏洞
审核时请保持专业和友善的态度,提出建设性的建议,帮助团队成员共同成长。

📚 相关资源 | Resources

YAML 规范

了解部署配置的标准格式

快速开始

快速上手项目部署

开发指南

本地开发环境配置

API 参考

查看完整的 API 文档
未经审核的代码不得直接合并到 main 分支。所有变更必须经过至少一名团队成员的审核。