> ## Documentation Index
> Fetch the complete documentation index at: https://docs.akria.net/llms.txt
> Use this file to discover all available pages before exploring further.

# 团队协作 | Team Collaboration

> 了解 Project Team 的开发流程、Git 工作流和协作规范

# 团队协作 | Team Collaboration

欢迎加入 **Project Team**！本文档将帮助你快速了解我们的开发流程和协作规范。

<Info>
  所有代码变更必须通过 Pull Request 进行审核，确保代码质量和团队协作的一致性。
</Info>

## 📋 开发流程 | Development Workflow

### Git 工作流

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

<Steps>
  <Step title="创建功能分支">
    从 `main` 分支创建新的功能分支：

    ```bash theme={null}
    git checkout -b feature/your-feature-name
    ```
  </Step>

  <Step title="开发与提交">
    进行开发工作，并遵循我们的提交规范：

    ```bash theme={null}
    git commit -m "feat: 添加新功能描述"
    ```
  </Step>

  <Step title="创建 Pull Request">
    将你的分支推送到远程仓库，并创建 Pull Request 等待审核。
  </Step>

  <Step title="代码审核">
    团队成员将审核你的代码，提出建议或批准合并。
  </Step>
</Steps>

## 📝 提交规范 | Commit Convention

我们遵循 [Conventional Commits](https://www.conventionalcommits.org/) 规范：

<CodeGroup>
  ```bash 功能提交 theme={null}
  git commit -m "feat: 添加 K3s 部署脚本"
  ```

  ```bash 修复提交 theme={null}
  git commit -m "fix: 修复 YAML 配置中的资源限制问题"
  ```

  ```bash 文档提交 theme={null}
  git commit -m "docs: 更新团队协作规范"
  ```

  ```bash 重构提交 theme={null}
  git commit -m "refactor: 优化部署流程"
  ```
</CodeGroup>

### 提交类型

| 类型         | 说明     | 示例                   |
| ---------- | ------ | -------------------- |
| `feat`     | 新功能    | `feat: 添加自动扩缩容功能`    |
| `fix`      | 修复 Bug | `fix: 修复服务启动失败问题`    |
| `docs`     | 文档更新   | `docs: 更新 API 文档`    |
| `style`    | 代码格式   | `style: 格式化 YAML 文件` |
| `refactor` | 重构     | `refactor: 优化部署脚本`   |
| `test`     | 测试相关   | `test: 添加单元测试`       |
| `chore`    | 构建/工具  | `chore: 更新依赖版本`      |

## 🔄 Pull Request 规范

### PR 标题格式

```
<type>: <简短描述>
```

示例：

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

### PR 描述模板

<Accordion title="查看 PR 描述模板" icon="file-lines">
  ```markdown theme={null}
  ## 变更描述
  简要描述本次 PR 的主要变更内容。

  ## 变更类型
  - [ ] 新功能
  - [ ] Bug 修复
  - [ ] 文档更新
  - [ ] 重构
  - [ ] 其他

  ## 测试说明
  描述如何测试这些变更，包括测试步骤和预期结果。

  ## 相关 Issue
  关联的 Issue 编号（如有）
  ```
</Accordion>

## 🛡️ 代码审核 | Code Review

### 审核清单

在提交 PR 前，请确保：

* [ ] 代码符合项目规范
* [ ] 已通过本地测试
* [ ] 文档已更新（如需要）
* [ ] 提交信息符合规范
* [ ] 没有引入安全漏洞

<Tip>
  审核时请保持专业和友善的态度，提出建设性的建议，帮助团队成员共同成长。
</Tip>

## 📚 相关资源 | Resources

<CardGroup cols={2}>
  <Card title="YAML 规范" icon="file-code" href="/technical/infra-deploy/yaml-best-practices">
    了解部署配置的标准格式
  </Card>

  <Card title="快速开始" icon="rocket" href="/guides/website-overview/quickstart">
    快速上手项目部署
  </Card>

  <Card title="开发指南" icon="code" href="/guides/website-overview/development">
    本地开发环境配置
  </Card>

  <Card title="API 参考" icon="book" href="/technical/api-reference/introduction">
    查看完整的 API 文档
  </Card>
</CardGroup>

<Warning>
  未经审核的代码不得直接合并到 `main` 分支。所有变更必须经过至少一名团队成员的审核。
</Warning>