Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

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

Đang mở Phù hợp với người mới
#2,797 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
75/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
swift, typescript
Lĩnh vực
documentation

Hướng nghiên cứu

Tệp cần cập nhật là apple/runner/RUNNER_PROTOCOL.md. Đầu tiên, xác minh vị trí hiện tại của tên lệnh trong packages/platform-apple/src/runner/runner-contract.ts:53-94. Sau đó, kiểm tra các tệp được liên kết cho mã khôi phục và lỗi: runner/runner-command-recovery.ts, AgentDeviceRunnerUITests/RunnerTests+Transport.swift và RunnerTests+CommandJournal.swift. Cập nhật tài liệu với các tham chiếu chính xác và giải thích ngắn gọn, đảm bảo tất cả các ký hiệu tồn tại qua git grep. Cuối cùng, chạy pnpm check:agent-guidance để xác nhận các thay đổi được thông qua.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.
Ngôn ngữ chính
TypeScript
Star
4.7k
Fork
304
Merge trung bình
11 giờ 29 phút
Pull request đã merge (30 ngày)
514

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của callstack/agent-device

Tất cả issue của callstack/agent-device

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.