页面结构
体检页由几个标签组成:
| 标签 | 用途 |
|---|---|
| 任务对话 | 发起体检、查看当前任务的执行进度 |
| 体检报告 | 阅读结论、证据与建议,导出报告 |
| 贡献路径 | 在体检的同一提交上验证贡献流程,见贡献路径验证 |
| 历史任务 | 找回之前的体检记录 |
| 新任务 | 清空表单,开始另一次体检 |
页面侧边的“执行轨迹与证据”显示五个阶段的实时状态、本次上下文(仓库、模型、提交)和执行服务是否在线。
发起体检
- 填写 GitHub 仓库地址,例如
https://github.com/owner/repository;分支留空表示默认分支。可以点击“试填示例仓库”快速体验。 - 查看模式提示:
- 基础规则模式:没有可用的默认模型,只运行 8 项规则检查。点击“配置模型”可前往设置。
- 已选择模型:额外运行 3 项内容研判,提示中会显示使用的模型。
- 点击“发送仓库,开始体检”。任务创建后会把该仓库设为当前项目。
执行阶段
| 阶段 | 做什么 |
|---|---|
| 读取仓库 | 确认仓库可访问,锁定分支当前的提交 SHA |
| 收集文件 | 读取目录树和需要的文件内容;目录过大时可能被截断,报告会注明 |
| 规范检查 | 运行 8 项规则检查 |
| 内容研判 | 启用模型时,由模型在快照中只读核对文档内容;未启用时显示“已跳过” |
| 生成报告 | 汇总结论、校验引用,生成报告 |
进度通过实时事件推送,连接中断时页面显示“正在重连进度”,任务本身不受影响。任务在“等待执行”状态停留较久,通常是体检 Worker 没有运行,见常见问题。
运行中可以点击“停止体检”,已完成的执行记录会保留;之后可以重新发起体检。
检查项目
规则检查(8 项)
| 检查项 | 类别 | 怎样算“已通过” | 注意 |
|---|---|---|---|
| 项目说明 | 文档 | 在根目录、docs/ 或 .github/ 中找到常见命名的 README | 内容是否完整由内容研判判断 |
| 开源许可 | 文档 | 根目录有 LICENSE / LICENCE / COPYING 文件 | 不判断许可证类型和合规性 |
| 贡献指南 | 协作 | 找到 CONTRIBUTING 文件 | 不判断流程说明是否充分 |
| Issue 模板 | 协作 | 找到 Issue 模板文件 | 只有 config.yml 不算模板 |
| PR 模板 | 协作 | 找到 Pull Request 模板 | 不验证模板内容 |
| 持续集成 | 工程 | 存在 .github/workflows/*.yml | 不查询运行结果,不代表 CI 已通过;不检测外部 CI 服务 |
| 测试入口 | 工程 | 识别到测试入口,例如 package.json 中有效的 test 脚本、pytest / tox 配置,或 Python、Go、Java 测试文件 | 未运行测试,不代表测试通过 |
| 代码规范配置 | 工程 | 找到 ESLint、Biome、Prettier、oxlint、Ruff、golangci-lint、rustfmt、Checkstyle 等配置或 lint / format 脚本 | 未执行检查 |
测试入口和代码规范配置按常见命名识别,对根目录的 Node.js 项目识别最完整。仓库包含工作区或子项目、或目录被截断时,结果可能是“无法判断”,这不代表项目没有测试。
内容研判(3 项,需要模型)
| 检查项 | 判断什么 |
|---|---|
| README 内容可用性 | README 是否说明项目用途、安装方法和最小使用示例 |
| 贡献说明可用性 | 贡献者能否从文档中知道如何开发、验证和提交 |
| 文档与项目命令一致性 | 文档里写的命令是否和项目配置中的脚本一致 |
模型只能使用三个只读工具:查看快照目录、读取快照文件、搜索快照内容,无法访问快照以外的内容。每条结论都必须引用真实路径和逐字原文,引用核验不通过的结论不会被采纳,相关文件被截断时会标为无法判断。
阅读报告
报告标题下方显示仓库、分支、提交和生成时间,并说明本次是否包含 AI 内容分析。
三种状态
| 状态 | 含义 | 你需要做什么 |
|---|---|---|
| 已通过 | 在本次提交中找到了对应的文件或配置 | 可在依据中核对文件;必要时人工确认内容质量 |
| 待完善 | 缺少对应文件,或内容研判发现明显缺口 | 阅读建议,决定是否改进 |
| 无法判断 | 证据不足、目录不完整或项目结构不在支持范围内 | 人工查看,不要当作通过或失败 |
维护检查清单
- 用类别(全部 / 文档 / 协作 / 工程)和状态筛选,建议先看“待完善”。
- 展开一项,阅读结论、依据和改进建议。依据会注明来源是“规则检查”还是“内容研判”,并列出文件路径、原文片段或 GitHub 链接。
- 展开“内容核对工具记录”,可以看到模型实际执行过的读取和搜索操作(不展示模型内部推理)。
导出:报告可导出为 Markdown 或 JSON,文件名形如 repocare-仓库名-提交短SHA.md。导出内容同样只对应该提交。
体检之后
报告页提供几个后续入口:
- 生成改进草稿:为待完善项生成文档草稿,进入草稿与交付编辑。需要默认模型。
- 验证贡献路径:在同一提交上验证新贡献者能否跑通安装和测试,见贡献路径验证。
- 改进方案:点击“核对跨文件改进依据”,围绕待完善项启动一次维护调查,适合需要同时修改多个文件的情况。
- 查看项目概览:概览和维护观测图表会使用这份报告。
仓库有新提交时,点击“重新体检最新提交”。旧报告保留在历史任务中,但不能用来解释新提交。