Skip to content
This page has been auto-translated and may contain errors.View in English

Pull requests ​

Un pull request contiene todos los detalles que un revisor podría necesitar, pero ninguno del contexto que tenía su autor. Un explicador del PR le da al revisor ese contexto en unos minutos: para qué es el cambio, cómo funciona y qué partes merecen una mirada más atenta.

Acá tienes uno, generado automáticamente para un PR en el propio repositorio de la action: Scrimba PR Guide Workflow.

hazme un explicador de este PR para el revisorexplica qué cambia este branch y por quéguíame por el bug que arregla este PR y cómo lo hace

Tres formas de conseguir uno ​

Desde tu agente de código. Conecta Claude Code, o cualquier herramienta que hable MCP, y pídele que explique el PR. El agente tiene el repositorio a mano, así que lee el diff, el código alrededor y el historial, y luego escribe la lección él mismo. No hay nada que instalar en el repositorio.

Automáticamente, en cada PR. Agrega la GitHub Action de Scrimba PR Explainer y cada pull request obtiene un explicador apenas se abre, publicado como comentario para quien lo revise.

Desde ChatGPT o Codex. Con el plugin @Explain Video Generator instalado, pide un video del pull request que estás viendo. Codex tiene el código a mano, así que funciona igual que un agente de código. En ChatGPT, primero pega el diff o adjunta los archivos modificados.

La extensión de Chrome no es la herramienta indicada para esto. Explica la página que estás leyendo, así que en un pull request solo ve lo que GitHub muestra en pantalla, no el repositorio que hay detrás.

La GitHub Action ​

scrimba/pr-explainer es la GitHub Action propia de Scrimba. En cada pull request que queda listo para revisión, ejecuta Claude Code sobre el código descargado, transmite un explicador a Scrimba a través del endpoint de plugins de agentes y CI, y mantiene un solo comentario actualizado en el pull request con el enlace.

Qué necesitas ​

  • Un repositorio en GitHub con Actions habilitado.
  • Node.js 20.12 o más nuevo, para el instalador.
  • Claude Code. La action funciona con un token OAuth de Claude Code de tu suscripción, así que no hace falta ninguna API key.
  • Opcional: la CLI de GitHub, con sesión iniciada mediante gh auth login, para que el instalador pueda guardar el token por ti.

Cómo configurarla ​

Ejecuta el instalador desde una copia local del repositorio:

bash
npx pr-explainer

Esto escribe .github/workflows/scrimba-pr-explainer.yml, y luego te ofrece configurar el único secreto que necesita el workflow. Si aceptas, ejecuta claude setup-token por ti, o te pide que pegues un token, y lo guarda como SCRIMBA_PR_EXPLAINER_CLAUDE_CODE_OAUTH_TOKEN en el repositorio.

El instalador no hace ningún commit. Haz commit del archivo de workflow y súbelo (push), y la action queda activa.

Si te saltas la configuración automática, o la CLI de GitHub no está disponible, haz tú mismo estos dos pasos:

bash
claude setup-token
gh secret set SCRIMBA_PR_EXPLAINER_CLAUDE_CODE_OAUTH_TOKEN

Qué pasa en un pull request ​

El workflow se ejecuta cuando se abre un pull request, se reabre, recibe un push, o se marca como listo para revisión. Los pull requests en borrador se saltan hasta que se marcan como listos.

El job descarga el commit de merge del pull request y le entrega a Claude Code el título del PR, la descripción, los issues vinculados y el diff. Lee los archivos modificados tal como están ahora, el código a su alrededor y las pruebas cercanas, y luego escribe el explicador. Nunca modifica el repositorio.

Aparece un comentario en el pull request de inmediato y se va actualizando a medida que avanza la ejecución:

  • En cola, y luego Generando cuando Claude Code empieza a trabajar.
  • Listo, con un enlace para Ver el explicador. El enlace llega mientras el explicador todavía se está escribiendo, así que puedes empezar a verlo antes de que termine la ejecución.
  • Omitido, con una razón de una línea, cuando el cambio es demasiado pequeño para justificar un video: la corrección de un error tipográfico, un cambio solo de formato, la edición de un comentario o una actualización del archivo de bloqueo (lockfile).
  • Falló, con un enlace al registro del workflow.

El explicador es una ayuda, no un requisito para poder hacer merge: una ejecución fallida nunca bloquea el merge, y el check sigue pasando. Un nuevo push cancela una ejecución que sigue en curso y comienza una nueva para el commit más reciente.

Qué cubre el explicador ​

Cada uno está construido en tres actos:

  1. El escenario. Para qué sirve el PR, en términos simples, y las partes del sistema que toca, presentadas siguiendo un evento real a través de ellas.
  2. El cómo. Los flujos que el cambio agrega o modifica, mostrados como diapositivas de diff lado a lado con el puntero en las líneas exactas, más un diagrama o animación cuando la forma o el movimiento explican más que el código.
  3. Los problemas. Problemas que el agente pudo verificar, uno por diapositiva, cada uno con el caso que falla y la solución más pequeña posible, y una opinión clara sobre si debería bloquear el merge. Un PR limpio recibe una sola diapositiva que dice justamente eso.

El explicador enseña a partir de código y diffs reales. Nunca usa imágenes generadas.

Quién puede verlo ​

El explicador es no listado: cualquiera con el enlace puede verlo, sin necesidad de cuenta de Scrimba. Eso es lo que hace que el enlace funcione para cualquiera que esté leyendo el pull request.

Todavía no tiene dueño. La primera persona que abre el enlace, inicia sesión y lo reclama se convierte en su propietario y controla su visibilidad desde ese momento. Consulta Privacidad, reclamos y compartir.

Repositorios de código abierto

En un repositorio público, el comentario del pull request también es público, y el enlace que contiene también lo es. Quien reclame el explicador primero se convierte en su dueño.

Forks ​

Los pull requests que vienen de forks se omiten por defecto, y el workflow explica por qué en un comentario justo arriba de esa configuración. El agente lee el contenido del pull request con acceso al repositorio descargado y al token que se le pasa al job, así que un PR de un fork podría llevar instrucciones dirigidas a él.

Activa allow-forks: true en la action solo si confías en todos los forks que puedan abrir un pull request contra el repositorio.

Ejecutarlo manualmente ​

El workflow también se puede iniciar desde la pestaña Actions. Elige Scrimba PR Explainer, haz clic en Run workflow e ingresa el número de un PR. Esto regenera el explicador sin necesidad de un commit nuevo.

Opciones ​

Estas van bajo with: en el paso de la action dentro del archivo de workflow.

EntradaValor por defectoQué hace
pr-numberEl PR del evento que disparó la ejecuciónQué pull request explicar
modelEl modelo por defecto de Claude CodeEl modelo de Claude a ejecutar, como opus o claude-opus-5-5
allow-forksfalseSi los pull requests de forks reciben un explicador
agentsclaudeQué agente escribe el explicador. Por ahora solo se admite Claude

Solución de problemas ​

La ejecución falla con "Missing SCRIMBA_PR_EXPLAINER_CLAUDE_CODE_OAUTH_TOKEN secret". El secreto no está configurado en el repositorio. Ejecuta los dos comandos que aparecen en Cómo configurarla.

No aparece ningún comentario. Verifica que el pull request no sea un borrador, que venga del mismo repositorio y no de un fork, y que el archivo de workflow todavía tenga issues: write bajo permissions y GH_TOKEN en el env del paso. El instalador escribe todo eso.