草稿从哪里来
| 类型 | 来源 | 交付方式 |
|---|---|---|
| 文档改进 | 体检报告中的待完善项 | 在独立分支上创建 Draft PR |
| Issue 回复 | Issue 详情中的“生成回复草稿”或“生成补充信息回复” | 作为 Issue 评论发布 |
| PR 评论 | PR 详情中筛选后的审查发现 | 作为 COMMENT 类型的 PR 审阅发布 |
从体检生成文档改进:页面顶部的“从体检问题生成文档改进”使用当前项目、当前分支最近一次成功的体检报告,列出可以生成草稿的待完善项。点击“生成草稿”会调用默认模型,不会发布;同一项已有草稿时显示“生成新版本”。当前分支还没有成功报告时,会提示先开始项目体检。
查找草稿
- 分类:全部、文档改进、Issue 回复、PR 评论。
- 搜索:按标题、文件路径或编号搜索,覆盖当前项目的全部草稿,而不只是当前页。
- 状态:待处理(默认)、待审阅、待核对、已交付、已归档、全部未归档。
- 显示同目标旧草稿:同一个目标(同一文件或同一讨论)有多份草稿时,默认只显示最新的一份。
列表中会标出草稿的来源、分支,以及是否有未保存的修改。
审阅与编辑
打开一份草稿后,有三种审阅视图:
| 视图 | 用途 |
|---|---|
| 差异 | 逐行比较。基准可以选“原始文件 / 发布前内容”或“上一份生成草稿”;未修改的行默认折叠,勾选“展开未修改行”查看全文 |
| 编辑 | 直接修改 Markdown 内容 |
| 预览 | 查看渲染效果;图片不会加载,只显示地址 |
来源与版本区域显示草稿依据的体检、Issue 或 PR,以及基于的提交。可以跳回“原始体检”或“原始讨论”核对。
编辑后点击“保存”。每次保存形成一个版本,最多保留最近 20 个历史版本;可以把任意历史版本“恢复为新版本”。
内容检查
RepoCare 会基于固定快照对草稿内容做静态检查,结果分为三类:
| 级别 | 示例 |
|---|---|
| 阻断 | 内容为空;超过 30,000 字符;疑似包含凭据或私钥;存在不安全的链接协议 |
| 提醒 | 存在占位符或待确认内容;原有章节标题被移除或改名;许可证或版权说明可能被移除;内容缩短超过一半;引用的 npm 脚本在 package.json 中不存在;相对链接在快照中找不到目标 |
| 未验证 / 边界 | 外部链接没有联网检查;快照不足,部分相对链接未验证;只核对脚本配置,没有执行命令 |
有阻断项时不能发布。检查不保证语义正确,也不执行命令或探测网络,仍需你通读一遍。
确认交付
- 查看“交付准备”。以下情况会显示“交付前还需处理”:草稿已归档、有未保存的修改、内容检查存在阻断、正在发布、发布结果待核对,或尚未授予 GitHub 写入权限。
- 显示“可以进入交付审阅”后,点击对应的发布按钮:创建草稿 PR、发布 Issue 回复 或 发布 PR 评论。
- 在确认框中核对目标,勾选“我已审阅每份草稿的内容、差异及检查提醒;理解未执行命令或测试”,点击确认。
- 发布完成后,点击“打开 GitHub 结果”核对。
没有写入权限时,仍然可以编辑和“下载当前内容”;点击“设置 GitHub 授权”可以前往设置,完成后返回原草稿。远端权限和版本会在提交时再次校验。
文档改进会在名为 repocare/<草稿编号> 的独立分支上提交修改,并创建 Draft PR,不会直接改动你的目标分支。
合并多个文件为一个 Draft PR
同一分支、同一基准提交的文档改进可以合并交付:在列表中勾选 2 到 4 份不同文件的草稿,点击“审阅并创建一个草稿 PR”。不能同时选择同一文件的多个版本,批次中所有文件都要先保存。
交付之后
“交付与后续验证”区域会继续跟踪结果:
- PR 状态:已创建等待审阅、已合并或已关闭。点击“读取 GitHub 最新状态”刷新。
- 体检验证:合并后可以“重新体检(主动发起)”。新报告包含合并提交且关联检查通过时,会显示验证通过;仍待完善或无法判断时会如实显示。
- Issue 回复和 PR 评论发布后,状态显示“评论已发布”,这不表示问题已经解决。
结果待核对
网络中断或 GitHub 响应异常时,RepoCare 可能无法确认发布是否成功,草稿会进入 待核对 状态,并且不会自动重试,以免重复创建 PR 或评论。
- 点击“读取 GitHub 最新状态”,RepoCare 会尝试按记录找到对应的 PR 或评论。
- 仍无法确认时,打开原始讨论或仓库的 PR 列表人工核对。
- 确认远端确实没有内容后,再决定是否重新发布。
归档
不再需要的草稿可以“归档”,它会从“待处理”中移走,但保留全部历史;需要时“取消归档”。已归档的草稿不能发布。