Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

Abierto Apto para principiantes
#2,797 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
75/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
swift, typescript

Línea de trabajo

El archivo a actualizar es apple/runner/RUNNER_PROTOCOL.md. Primero, verifique la ubicación actual de los nombres de comandos en packages/platform-apple/src/runner/runner-contract.ts:53-94. Luego, examine los archivos vinculados para códigos de recuperación y error: runner/runner-command-recovery.ts, AgentDeviceRunnerUITests/RunnerTests+Transport.swift y RunnerTests+CommandJournal.swift. Actualice el documento con referencias correctas y explicaciones breves, asegurándose de que todos los símbolos existan mediante git grep. Finalmente, ejecute pnpm check:agent-guidance para confirmar que los cambios pasan.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.
Lenguaje dominante
TypeScript
Estrellas
4.7k
Forks
304
Merge medio
11 h 46 min
PR fusionados (30 d)
496

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de callstack/agent-device

Todos los issues de callstack/agent-device

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.