From 8ceb103cf7a74ee431e885bad6244efa245729c5 Mon Sep 17 00:00:00 2001 From: milo Date: Wed, 14 Oct 2026 17:43:55 +0000 Subject: [PATCH] =?UTF-8?q?=E6=B7=BB=E5=8A=A0=E5=9B=A2=E9=98=9F=E4=BD=BF?= =?UTF-8?q?=E7=94=A8=E6=8C=87=E5=8D=97?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- AI工具说明.md | 39 ++++++++++++++++++++++++++++ README.md | 70 +++++++++++++++++++++++++++++++++++++++++++++++++++ 使用指南.md | 70 +++++++++++++++++++++++++++++++++++++++++++++++++++ 协作规范.md | 45 +++++++++++++++++++++++++++++++++ 4 files changed, 224 insertions(+) create mode 100644 AI工具说明.md create mode 100644 README.md create mode 100644 使用指南.md create mode 100644 协作规范.md diff --git a/AI工具说明.md b/AI工具说明.md new file mode 100644 index 0000000..6c7f4ad --- /dev/null +++ b/AI工具说明.md @@ -0,0 +1,39 @@ +# 让 AI 编程工具（Cursor 等）使用我们的仓库 + +## 1. 准备 +1. 按 [使用指南](README.md) 创建一个**访问令牌**（repository 读写）。 +2. 复制仓库的 HTTPS 地址： +``` +https://git.yjsnpitext1145141.top/用户名/仓库名.git +``` +3. 在 Cursor 里：「Clone Repository」粘贴地址；或打开终端运行 `git clone 地址`。要密码时：用户名填你的用户名，密码粘贴令牌。 + +## 2. 复制给 AI 的提示词 +开始工作前，把下面这段整段发给 AI（把尖括号里的换成你的）： + +``` +我们团队的代码仓库在自建 Gitea 上： +- 网址：https://git.yjsnpitext1145141.top/ +- 本仓库：https://git.yjsnpitext1145141.top/<用户名>/<仓库名>.git +- 用 HTTPS 推送，SSH 端口是 2222（一般不用） + +请遵守： +1. 不要直接改 main 分支。每个任务先新建分支，例如 feature/登录页 或 fix/按钮错位（分支名用英文：feature/login-page）。 +2. 提交信息用简短清楚的中文，说明做了什么，例如「新增登录页面」「修复首页按钮错位」。小步多次提交。 +3. 绝对不要提交密码、API Key、令牌、.env 文件、私钥。先确认 .gitignore 里有 .env、node_modules 等，没有就加上。 +4. 不要提交大文件（视频、安装包、数据集、超过 10MB 的文件）。 +5. 做完后 push 分支，然后告诉我如何在 Gitea 网页上创建合并请求（Pull Request）到 main，并帮我写好 PR 标题和中文说明。 +6. 如果 push 时要求输入用户名密码，停下来提醒我：用户名填我的 Gitea 用户名，密码填我的访问令牌（不是登录密码）。不要把令牌写进代码或任何文件。 +7. 每一步都用通俗的话告诉我你在做什么。 +``` + +## 3. 推送时要密码怎么办 +- 用户名：你的 Gitea 用户名 +- 密码：**访问令牌** +- 令牌只粘贴到弹出的密码框里，**不要发到聊天群、不要写进代码**。 +- 令牌泄露了：去「设置 → 应用」删掉它，再生成一个新的。 + +## 4. 开 PR（合并请求） +1. 打开仓库网页，会提示你刚推送的分支，点「创建合并请求」。 +2. 目标分支选 `main`，写标题和说明（可以让 AI 写）。 +3. 提交后等「审查」机器人和老师看，按意见修改后再合并。 diff --git a/README.md b/README.md new file mode 100644 index 0000000..bad1e2a --- /dev/null +++ b/README.md @@ -0,0 +1,70 @@ +# 团队 Gitea 使用指南 + +地址：**https://git.yjsnpitext1145141.top/**　管理员：**milo（马铭喆）** + +> 另外两份文档：[AI 工具说明](AI工具说明.md) ｜ [协作规范](协作规范.md) + +## 1. 第一次登录 +1. 打开上面的地址，点右上角「登录」。 +2. 输入管理员发给你的用户名和初始密码。 +3. 系统会要求你**设置新密码**，设一个自己记得住的，别告诉别人。 + +## 2. 改名字和头像 +右上角头像 → 「设置」→「个人信息」：改「全名」后点「更新个人信息」。头像在「头像」里上传图片。 + +## 3. 新建仓库（项目） +1. 右上角「＋」→「新建仓库」。 +2. 填仓库名称（英文小写，如 `my-first-app`）。 +3. **勾选「私有」**（默认都建私有）。 +4. 勾上「初始化仓库」，点「创建仓库」。 +5. 建好后按 [协作规范](协作规范.md) 添加 `reviewer`、`teacher1`、`teacher2` 为协作者。 + +## 4. 在网页上传 / 修改文件 +- 上传：进仓库 →「添加文件」→「上传文件」→ 拖进去 → 写一句说明 →「提交变更」。 +- 修改：点开文件 → 右上角铅笔图标 → 改完 → 写说明 →「提交变更」。 + +## 5. 用电脑克隆 / 推送（HTTPS，推荐新手） +仓库页面右侧复制 HTTPS 地址，格式： +``` +https://git.yjsnpitext1145141.top/你的用户名/仓库名.git +``` +```bash +git clone https://git.yjsnpitext1145141.top/你的用户名/仓库名.git +cd 仓库名 +# 改代码后 +git add . +git commit -m "新增登录页面" +git push +``` +推送时问用户名和密码：用户名填你的用户名，密码填你的登录密码或**访问令牌（推荐）**。 + +### 创建访问令牌（token） +1. 头像 →「设置」→「应用」。 +2. 「管理访问令牌」处填个名字（如 `my-laptop`）。 +3. 权限里把 **repository** 选为「读写」，user 选「读」。 +4. 点「生成令牌」，**马上复制保存**（只显示一次）。 +5. 以后 git 或 AI 工具要密码时，粘贴这个令牌。 + +（会用 SSH 的同学：SSH 端口是 **2222**，地址 `ssh://git@git.yjsnpitext1145141.top:2222/用户名/仓库名.git`，先在「设置 → SSH/GPG 密钥」添加公钥。） + +## 6. 忘记密码 +直接找管理员 **milo（马铭喆）** 重置。 + +## 常见问题 +- **看不到别人的仓库？** 私有仓库要对方把你加为协作者。 +- **push 被拒绝 / 403？** 检查令牌权限是否勾了 repository 读写；或你没有该仓库写权限。 +- **一直弹密码框？** 密码要填令牌，不是邮箱；输错可在系统「凭据管理器/钥匙串」里删掉旧的再试。 +- **界面是英文？** 页面底部语言选「简体中文」。 +- **不小心传了密码/密钥？** 立刻告诉 milo，并把那个密码改掉。 + +## 团队成员 +| 用户名 | 姓名 | +|---|---| +| milo | 马铭喆（管理员） | +| xuzhaojia | 许兆嘉 | +| lijiatong | 李嘉桐 | +| weiheting | 魏赫廷 | +| gaozihan | 高子涵 | +| teacher1 | 指导老师1 | +| teacher2 | 指导老师2 | +| reviewer | 代码审查机器人「审查」 | diff --git a/使用指南.md b/使用指南.md new file mode 100644 index 0000000..bad1e2a --- /dev/null +++ b/使用指南.md @@ -0,0 +1,70 @@ +# 团队 Gitea 使用指南 + +地址：**https://git.yjsnpitext1145141.top/**　管理员：**milo（马铭喆）** + +> 另外两份文档：[AI 工具说明](AI工具说明.md) ｜ [协作规范](协作规范.md) + +## 1. 第一次登录 +1. 打开上面的地址，点右上角「登录」。 +2. 输入管理员发给你的用户名和初始密码。 +3. 系统会要求你**设置新密码**，设一个自己记得住的，别告诉别人。 + +## 2. 改名字和头像 +右上角头像 → 「设置」→「个人信息」：改「全名」后点「更新个人信息」。头像在「头像」里上传图片。 + +## 3. 新建仓库（项目） +1. 右上角「＋」→「新建仓库」。 +2. 填仓库名称（英文小写，如 `my-first-app`）。 +3. **勾选「私有」**（默认都建私有）。 +4. 勾上「初始化仓库」，点「创建仓库」。 +5. 建好后按 [协作规范](协作规范.md) 添加 `reviewer`、`teacher1`、`teacher2` 为协作者。 + +## 4. 在网页上传 / 修改文件 +- 上传：进仓库 →「添加文件」→「上传文件」→ 拖进去 → 写一句说明 →「提交变更」。 +- 修改：点开文件 → 右上角铅笔图标 → 改完 → 写说明 →「提交变更」。 + +## 5. 用电脑克隆 / 推送（HTTPS，推荐新手） +仓库页面右侧复制 HTTPS 地址，格式： +``` +https://git.yjsnpitext1145141.top/你的用户名/仓库名.git +``` +```bash +git clone https://git.yjsnpitext1145141.top/你的用户名/仓库名.git +cd 仓库名 +# 改代码后 +git add . +git commit -m "新增登录页面" +git push +``` +推送时问用户名和密码：用户名填你的用户名，密码填你的登录密码或**访问令牌（推荐）**。 + +### 创建访问令牌（token） +1. 头像 →「设置」→「应用」。 +2. 「管理访问令牌」处填个名字（如 `my-laptop`）。 +3. 权限里把 **repository** 选为「读写」，user 选「读」。 +4. 点「生成令牌」，**马上复制保存**（只显示一次）。 +5. 以后 git 或 AI 工具要密码时，粘贴这个令牌。 + +（会用 SSH 的同学：SSH 端口是 **2222**，地址 `ssh://git@git.yjsnpitext1145141.top:2222/用户名/仓库名.git`，先在「设置 → SSH/GPG 密钥」添加公钥。） + +## 6. 忘记密码 +直接找管理员 **milo（马铭喆）** 重置。 + +## 常见问题 +- **看不到别人的仓库？** 私有仓库要对方把你加为协作者。 +- **push 被拒绝 / 403？** 检查令牌权限是否勾了 repository 读写；或你没有该仓库写权限。 +- **一直弹密码框？** 密码要填令牌，不是邮箱；输错可在系统「凭据管理器/钥匙串」里删掉旧的再试。 +- **界面是英文？** 页面底部语言选「简体中文」。 +- **不小心传了密码/密钥？** 立刻告诉 milo，并把那个密码改掉。 + +## 团队成员 +| 用户名 | 姓名 | +|---|---| +| milo | 马铭喆（管理员） | +| xuzhaojia | 许兆嘉 | +| lijiatong | 李嘉桐 | +| weiheting | 魏赫廷 | +| gaozihan | 高子涵 | +| teacher1 | 指导老师1 | +| teacher2 | 指导老师2 | +| reviewer | 代码审查机器人「审查」 | diff --git a/协作规范.md b/协作规范.md new file mode 100644 index 0000000..3cad4fb --- /dev/null +++ b/协作规范.md @@ -0,0 +1,45 @@ +# 团队协作规范 + +## 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 审查机器人