目录

考研择校智能助手

面向计算机考研学生的一体化智能问答平台:院校择校 + 科目答疑 + 复习规划 + 心理鼓励,院校信息可查询、可溯源。

团队与分工

成员 角色 负责
王震 规约 把需求写成可执行、可验收的 OpenSpec 规约;维护边界与验收标准
钟宇平 开发 在同一仓库实现后端、AI 能力(RAG / 技能 / MCP)与前端,保持主路径可运行
王博 验收 用同一份规约核对功能、失败路径、权限与证据,不接受“模型声称完成”

仓库结构

.
├── AGENTS.md                  # 常驻工程规则(每次会话都会被读取)
├── CLAUDE.md                  # 指向 AGENTS.md
├── README.md                  # 本文件:定位、启动步骤、协作约定
├── .env.example               # 只写键名与占位值;复制为 .env 后填值
├── openspec/
│   ├── specs/                 # 已归档的能力规约(主基线)
│   └── changes/               # 进行中的变更;归档后移入 archive/
├── docs/
│   ├── mvp-scope.md           # 项目边界:本轮做什么、不做什么
│   ├── standards/             # 八份工程规范明细
│   └── verification/          # 每次验收的证据与记录
└── code/school-choice/        # 主工程:Spring Boot 3.5 + LangChain4j

code/ 下的其他目录是往期课程练习,保留在本机、不入库;note/ 为个人学习笔记,同样不入库。

当前状态

第 7 课:仓库、协作约定、首份变更规约已建立。骨架尚未实现,下面的启动步骤是目标形态,需在骨架课次由另一名成员从零验证后勾选。

从克隆到启动(目标步骤)

前置:JDK 17、Docker Desktop(含 Compose)、Git。

git clone https://gitlink.org.cn/w18625463316/school-choice-assistant.git
cd school-choice-assistant
cp .env.example .env          # 填入 API_KEY、DB_PASSWORD 等,明文只留在本机
cd code/school-choice
./mvnw spring-boot:run        # 骨架完成后应为:docker compose up
curl -s http://localhost:8080/health

/health 免认证,返回版本、时间与 MySQL / Redis 连通状态。README 中的步骤必须由未参与编写的成员在自己机器上从零跑通;在哪一步受阻就改哪一步。

协作约定

  1. main 唯一且受保护。 任何人不得直接向 main 推送;主干上每个提交都应能启动。
  2. 每次改动开一条变更。 目录为 openspec/changes/YYYY-MM-DD-短横小写英文名/,实现分支为 change/YYYY-MM-DD-短横小写英文名;验收通过后合并并归档。
  3. 提交信息写清依据。 格式:<变更名>: <改了什么>(tasks x.y)。禁止 update、fix 这类无信息量的提交信息。
  4. 规约先于代码。 没有场景的能力不实现;实现内容不超出当前 tasks.md。
  5. 每人各自克隆并跑通一次。 只在自己机器上能运行不算跑通。
  6. 验收看证据。 以 openspec validate --strict、测试结果、/health 响应与 docs/verification/ 记录为准。

密钥边界

  • 仓库只提交 .env.example(键名 + 占位值);.env 已被忽略。
  • 明文密钥只存在于本机环境变量与 .env;不进代码、不进镜像层、不进前端构建产物、不进日志与错误信息、不进问题单与截图。
  • 提交前检索密钥;一旦进入提交历史,立即轮换密钥并重写历史,删文件不算处理。

许可

本仓库暂未选择开源许可。原因是课程期间不对外公开演示,组内也未就许可证达成一致;如需公开,先补 LICENSE 并在本段更新选择与理由。

文档索引

  • 项目边界:docs/mvp-scope.md
  • 工程规则:AGENTS.md
  • 规范明细:docs/standards/
  • 首份变更:openspec/changes/2026-10-28-auth-chat/
  • 验收记录:docs/verification/
关于
485.0 KB
邀请码
    Gitlink(确实开源)
  • 加入我们
  • 官网邮箱:gitlink@ccf.org.cn
  • QQ群
  • QQ群
  • 公众号
  • 公众号

版权所有:中国计算机学会技术支持:开源发展技术委员会
京ICP备13000930号-9 京公网安备 11010802047560号