diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 00000000..c33a4de9 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,52 @@ +# CODEOWNERS · 光湖仓库 · 协作者权限保护 +# +# 作用:保护核心文件,修改时需要仓库所有者审批。 +# 配合 Branch Protection Rules 使用效果最佳(Settings → Branches → 开启分支保护)。 +# +# 设计原则: +# 只列出需要保护的核心目录/文件,模块目录(m01-* ~ m18-*)和 dev-nodes/ +# 不在此文件中列出,因此协作者可以自由提交到模块目录。 + +# ═══════════════════════════════════════════════════════ +# 核心基础设施 —— 需要仓库所有者审批 +# ═══════════════════════════════════════════════════════ + +# GitHub 工作流与自动化配置 +/.github/ @qinfendebingshuo + +# 自动化脚本 +/scripts/ @qinfendebingshuo + +# 铸渊聊天室前端 +/docs/ @qinfendebingshuo + +# 后端集成 / API 代理 +/backend-integration/ @qinfendebingshuo + +# 信号日志 +/signal-log/ @qinfendebingshuo + +# 根目录配置文件 +/package.json @qinfendebingshuo +/package-lock.json @qinfendebingshuo +/next.config.ts @qinfendebingshuo +/tsconfig.json @qinfendebingshuo +/README.md @qinfendebingshuo + +# ═══════════════════════════════════════════════════════ +# 以下目录【不受保护】—— 协作者可以自由提交 +# (因为未在此文件中列出,所以没有审批要求) +# +# /m01-login/ 肥猫 +# /m03-personality/ 肥猫 +# /m05-user-center/ 花尔 +# /m06-ticket/ 桔子 +# /m07-dialogue-ui/ 燕樊 +# /m10-cloud/ 燕樊 +# /m11-module/ 桔子 +# /m12-kanban/ 小草莓 +# /m15-cloud-drive/ 燕樊 +# /m18-health-check/ (待分配) +# /multi-persona/ (待分配) +# /dev-nodes/ 所有开发者个人工作区 +# ═══════════════════════════════════════════════════════ diff --git a/docs/.nojekyll b/docs/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/docs/使用指南.md b/docs/使用指南.md new file mode 100644 index 00000000..ed3659c9 --- /dev/null +++ b/docs/使用指南.md @@ -0,0 +1,110 @@ +# 🌀 铸渊助手 · 使用指南 + +--- + +## 一、网址 + +铸渊聊天室部署在 GitHub Pages 上,**正确网址**: + +``` +https://qinfendebingshuo.github.io/guanghulab/ +``` + +> ⚠️ 旧网址 `…/docs/index.html` 已失效(系统重构后路径变了),请用上面的新网址。 + +打开后你会看到铸渊助手的登录界面,选择你的身份即可开始对话。 + +--- + +## 二、怎么操作(冰朔 / 创始人) + +### 第一步:打开铸渊聊天室 + +1. 打开浏览器,访问上面的网址 +2. 在登录页面选择你的身份(如「冰朔」) +3. 点击「开始与铸渊对话」 + +### 第二步:和铸渊对话 + +- 在底部输入框打字,按回车发送 +- 铸渊会以 AI 回复你(需要 API 密钥,或使用后端代理模式) +- 左侧可以查看聊天记录、切换对话 +- 右侧可以看到团队状态面板 + +### 第三步:如果页面显示空白 + +- 等 1-2 分钟刷新,GitHub Pages 部署需要时间 +- 清除浏览器缓存后重试 +- 确认网址是否正确(不要加 `/docs/`) + +--- + +## 三、开发者(协作者)怎么上传模块 + +### 你只需要做一件事:把你的模块文件放到指定目录 + +每个开发者有自己负责的模块目录,例如: + +| 开发者 | 模块目录 | +|--------|----------| +| 肥猫 DEV-002 | `m01-login/`、`m03-personality/` | +| 燕樊 DEV-003 | `m07-dialogue-ui/`、`m10-cloud/`、`m15-cloud-drive/` | +| 小草莓 DEV-005 | `m12-kanban/` | +| 花尔 DEV-009 | `m05-user-center/` | +| 桔子 DEV-010 | `m06-ticket/`、`m11-module/` | + +### 上传步骤(最简单方式) + +1. 打开仓库页面:https://github.com/qinfendebingshuo/guanghulab +2. 找到你负责的模块目录(如 `m01-login/`) +3. 点击「Add file」→「Upload files」 +4. 拖拽你的文件上去 +5. 在底部写一句说明,点击「Commit changes」 + +### 注意事项 + +- ✅ **只在你的模块目录里上传文件** +- ❌ **不要修改仓库根目录的文件**(如 package.json、README 等) +- ❌ **不要修改 `.github/` 目录**(工作流、配置文件) +- ❌ **不要修改 `scripts/` 目录**(自动化脚本) +- ❌ **不要修改 `docs/` 目录**(铸渊聊天室界面) + +> 仓库已设置 CODEOWNERS 保护,核心文件的修改需要仓库所有者审批。 + +--- + +## 四、常见问题 + +### Q: 铸渊聊天室打不开? +- 确认网址正确:`https://qinfendebingshuo.github.io/guanghulab/` +- 不要在后面加 `/docs/index.html` +- 等几分钟再刷新(部署有延迟) + +### Q: 我上传了文件,但好像不对? +- 确认你是在自己负责的模块目录里上传 +- 不要在仓库根目录直接上传 +- 如果不确定,联系冰朔确认 + +### Q: 我不小心改了不该改的文件? +- 如果开启了 Branch Protection,你的改动会变成 PR 等待审批 +- 联系冰朔处理即可 + +--- + +## 五、仓库安全设置建议(给冰朔) + +为了让 CODEOWNERS 保护生效,请在 GitHub 仓库设置中开启分支保护: + +1. 打开仓库 → Settings → Branches +2. 点击「Add branch protection rule」 +3. Branch name pattern 填 `main` +4. 勾选以下选项: + - ✅ Require a pull request before merging(合并前需要 PR) + - ✅ Require review from Code Owners(需要代码所有者审批) +5. 点击「Create」保存 + +这样协作者推送到 main 分支时,修改核心文件的 PR 会自动要求你审批。 + +--- + +💙 铸渊 · 2026-03-07