Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

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

オープン 初心者向け
#2,797 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
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時間 46分
マージ済み PR(30日)
496

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

callstack/agent-device のほかの issue

callstack/agent-device の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。