Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

docs(ios-runner): RUNNER_PROTOCOL.md points at the wrong file and omits recovery and busy codes

已关闭 适合新手
#2,797 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
75/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
技术栈
swift, typescript
领域
documentation

调研方向

要更新的文件是 apple/runner/RUNNER_PROTOCOL.md。首先,在 packages/platform-apple/src/runner/runner-contract.ts:53-94 中验证当前命令名称的位置。然后,检查用于恢复和错误代码的链接文件:runner/runner-command-recovery.ts、AgentDeviceRunnerUITests/RunnerTests+Transport.swift 和 RunnerTests+CommandJournal.swift。使用正确的引用和简要说明更新文档,并通过 git grep 确保所有符号都存在。最后,运行 pnpm check:agent-guidance 以确认更改通过。

由索引模型根据 Issue 内容生成。

描述

documentation good first issue ready-for-agent

Purpose

apple/runner/RUNNER_PROTOCOL.md:67 says the command names live in runner-client.ts. They are in packages/platform-apple/src/runner/runner-contract.ts:53-94. The doc also doesn't mention:

  • commandId and status recovery (the command journal)
  • runnerFatal and runnerMainThreadBusy
  • the error codes RUNNER_BUSY, RUNNER_WEDGED and MAIN_THREAD_TIMEOUT

Line references are at 01328de411.

Required behavior

  • Fix the pointer.
  • Add a short section for each missing concept: when it is produced, what it means, and what the daemon does with it. Link to the declaration sites (runner-contract.ts, runner/runner-command-recovery.ts, apple/runner/AgentDeviceRunner/AgentDeviceRunnerUITests/RunnerTests+Transport.swift, RunnerTests+CommandJournal.swift) and don't copy tables.

Completion conditions

  • Every symbol the doc names exists: check with git grep.
  • pnpm check:agent-guidance is green, if the doc is part of that check.
主要语言
TypeScript
星标
4.7k
派生
304
平均合并
11 小时 29 分钟
30 天内合并 PR
514

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

callstack/agent-device 的其他 Issue

查看 callstack/agent-device 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。