46 行
2.1 KiB
Markdown
46 行
2.1 KiB
Markdown
# 团队协作规范
|
||
|
||
## 1. 仓库命名
|
||
- 英文小写，单词用 `-` 连接：`todo-app`、`week1-homework`。
|
||
- 不用中文、空格、特殊符号。描述里可以写中文。
|
||
|
||
## 2. 每个私有仓库都要加协作者
|
||
仓库 →「设置」→「协作者」，逐个搜索添加：
|
||
| 用户名 | 身份 | 权限 |
|
||
|---|---|---|
|
||
| `reviewer` | 代码审查机器人「审查」 | 读取 |
|
||
| `teacher1` | 指导老师1 | 读取 |
|
||
| `teacher2` | 指导老师2 | 读取 |
|
||
|
||
不加的话，审查机器人和老师都看不到你的代码。
|
||
|
||
## 3. 工作流程：分支 → PR → 审查 → 合并
|
||
1. 新任务先建分支：`feature/功能英文名` 或 `fix/问题英文名`。
|
||
2. 在分支上改代码、提交、推送。
|
||
3. 在网页上创建合并请求（PR）到 `main`。
|
||
4. 「审查」机器人会自动看代码并留言；老师也可能评论。
|
||
5. 按意见修改（继续推到同一分支即可），没问题后再点「合并」。
|
||
6. 团队共享仓库建好后，**不要直接推送到 main**，一律走 PR。
|
||
|
||
## 4. 提交信息怎么写
|
||
- 中文、一句话说清楚做了什么：
|
||
- ✅ `新增用户登录页面`
|
||
- ✅ `修复首页按钮点击没反应`
|
||
- ❌ `update`、`改了点东西`、`111`
|
||
- 一次提交只做一件事，小步多提交。
|
||
|
||
## 5. 绝对不能上传的东西
|
||
- 密码、API Key、访问令牌、私钥、`.env` 文件
|
||
- 大文件：视频、安装包、压缩包、数据集、超过 10MB 的文件
|
||
- `node_modules`、`__pycache__` 等自动生成的文件夹（写进 `.gitignore`）
|
||
|
||
不小心传了密钥：**马上告诉 milo，并作废/更换那个密钥**（删掉文件不够，历史里还在）。
|
||
|
||
## 6. 有问题找谁
|
||
- 账号、密码、权限：管理员 **milo（马铭喆）**
|
||
- 代码看不懂、审查意见不明白：在 PR 里回复问「审查」，或问 teacher1 / teacher2
|
||
- 不知道怎么操作：先看 [使用指南](README.md) 和 [AI 工具说明](AI工具说明.md)
|
||
|
||
## 团队成员
|
||
milo 马铭喆（管理员）、xuzhaojia 许兆嘉、lijiatong 李嘉桐、weiheting 魏赫廷、gaozihan 高子涵、teacher1 指导老师1、teacher2 指导老师2、reviewer 审查机器人
|