Pull requests

Um pull request reúne todos os detalhes que um revisor poderia querer, mas nenhum do contexto que o autor tinha. Um explainer do PR dá esse contexto ao revisor em poucos minutos: para que serve a mudança, como ela funciona e quais partes merecem um olhar mais atento.

Aqui está um exemplo, gerado automaticamente para um PR no próprio repositório da action: Scrimba PR Guide Workflow.

›faça um explainer deste PR para o revisor›explique o que essa branch muda e por quê›me explique o bug que esse PR corrige e como

Três formas de conseguir um

Pelo seu agente de código. Conecte o Claude Code, ou qualquer ferramenta que fale MCP, e peça para ele explicar o PR. O agente tem acesso ao repositório, então ele lê o diff, o código ao redor e o histórico, e depois escreve a aula por conta própria. Não é preciso instalar nada no repositório.

Automaticamente, em todo PR. Adicione a GitHub Action Scrimba PR Explainer e cada pull request passa a receber um explainer no momento em que é aberto, postado como comentário para quem for revisá-lo.

Pelo ChatGPT ou Codex. Com o plugin @Explain Video Generator instalado, peça um vídeo do pull request que você está vendo. O Codex tem acesso ao código, então funciona do mesmo jeito que um agente de código. No ChatGPT, cole o diff ou anexe os arquivos alterados primeiro.

A extensão do Chrome não é a ferramenta certa para isso. Ela explica a página que você está lendo, então, num pull request, ela vê apenas o que o GitHub exibe na tela, não o repositório por trás dele.

A GitHub Action

scrimba/pr-explainer é a GitHub Action da própria Scrimba. Em todo pull request pronto para revisão, ela executa o Claude Code sobre o código já baixado, transmite um explainer para a Scrimba pelo endpoint de plugins de agente e CI e mantém um comentário no pull request atualizado com o link.

O que você precisa

• Um repositório no GitHub com Actions habilitado.
• Node.js 20.12 ou mais recente, para o instalador.
• Claude Code. A action roda com um token OAuth do Claude Code da sua assinatura, então nenhuma chave de API é necessária.
• Opcional: a CLI do GitHub, autenticada com gh auth login, para que o instalador possa guardar o token para você.

Configurando

Execute o instalador a partir de uma cópia local do repositório:

npx pr-explainer

Ele grava o arquivo .github/workflows/scrimba-pr-explainer.yml e, em seguida, oferece para configurar o único secret que o workflow precisa. Se você aceitar, ele executa claude setup-token por você, ou pede que você cole um token, e o armazena como SCRIMBA_PR_EXPLAINER_CLAUDE_CODE_OAUTH_TOKEN no repositório.

O instalador não faz nenhum commit. Faça o commit do arquivo do workflow e um push, e a action já estará funcionando.

Se você pular a configuração automática, ou a CLI do GitHub não estiver disponível, faça você mesmo os mesmos dois passos:

claude setup-token
gh secret set SCRIMBA_PR_EXPLAINER_CLAUDE_CODE_OAUTH_TOKEN

O que acontece em um pull request

O workflow é executado quando um pull request é aberto, reaberto, recebe um push ou é marcado como pronto para revisão. Pull requests em modo rascunho são ignorados até serem marcados como prontos.

O job baixa o merge commit do pull request e passa ao Claude Code o título do PR, a descrição, as issues vinculadas e o diff. Ele lê os arquivos alterados como estão agora, o código ao redor deles e os testes próximos, e então escreve o explainer. Ele nunca modifica o repositório.

Um comentário aparece no pull request imediatamente e é atualizado conforme a execução avança:

• Queued (na fila), depois Generating (gerando) quando o Claude Code começa.
• Done (concluído), com um link Watch explainer (assistir explainer). O link chega enquanto o explainer ainda está sendo escrito, então você pode começar a assistir antes mesmo de a execução terminar.
• Skipped (ignorado), com um motivo em uma linha, quando a mudança é pequena demais para valer um vídeo: correção de erro de digitação, mudança apenas de formatação, edição de comentário ou atualização de lockfile.
• Failed (falhou), com um link para o log do workflow.

O explainer é um auxílio, não um bloqueio para o merge: uma execução com falha nunca impede o merge, e o check continua passando. Um novo push cancela uma execução ainda em andamento e inicia uma nova para o commit mais recente.

O que o explainer aborda

Cada um é construído em três atos:

1. O cenário. Para que serve o PR, em termos simples, e as partes do sistema que ele afeta, apresentadas ao acompanhar um evento real passando por elas.
2. O como. Os fluxos que a mudança adiciona ou altera, percorridos lado a lado em slides de diff com o cursor apontando para as linhas exatas, além de um diagrama ou animação quando a estrutura ou o movimento explicam mais do que o código.
3. Os problemas. Problemas que o agente conseguiu verificar, um por slide, cada um com o caso que falha e a menor correção possível, e uma avaliação direta sobre se isso deveria bloquear o merge. Um PR limpo recebe um slide dizendo exatamente isso.

O explainer ensina a partir de código e diffs reais. Ele nunca usa imagens geradas.

Quem pode assistir

O explainer é não listado: qualquer pessoa com o link pode assistir, sem precisar de uma conta na Scrimba. É isso que faz o link funcionar para todo mundo que está lendo o pull request.

Ele ainda não pertence a ninguém. A primeira pessoa a abrir o link, fazer login e reivindicá-lo se torna sua proprietária e passa a controlar sua visibilidade a partir daí. Veja Privacidade, reivindicação e compartilhamento.

Repositórios open source

Em um repositório público, o comentário do pull request também é público, e o link dentro dele também. Quem reivindicar o explainer primeiro é quem passa a ser o proprietário.

Forks

Pull requests vindos de forks são ignorados por padrão, e o workflow explica o motivo em um comentário acima dessa configuração. O agente lê o conteúdo do pull request com acesso ao repositório baixado e ao token passado para o job, então um PR de fork poderia conter instruções direcionadas a ele.

Defina allow-forks: true na action somente se você confia em todos os forks que podem abrir um pull request contra o repositório.

Executando manualmente

O workflow também pode ser iniciado pela aba Actions. Escolha Scrimba PR Explainer, clique em Run workflow e informe o número do PR. Isso regenera o explainer sem precisar de um novo commit.

Opções

Elas ficam sob with: no step da action, no arquivo do workflow.

Entrada	Padrão	O que faz
pr-number	O PR do evento que disparou o workflow	Qual pull request explicar
model	O padrão do Claude Code	O modelo Claude a ser executado, como opus ou claude-opus-5-5
allow-forks	false	Se pull requests de forks recebem um explainer
agents	claude	Qual agente escreve o explainer. Por enquanto, só o Claude é suportado

Solução de problemas

A execução falha com "Missing SCRIMBA_PR_EXPLAINER_CLAUDE_CODE_OAUTH_TOKEN secret". O secret não está configurado no repositório. Execute os dois comandos em Configurando.

Nenhum comentário aparece. Verifique se o pull request não é um rascunho, se ele vem do próprio repositório e não de um fork, e se o arquivo do workflow ainda tem issues: write em permissions e GH_TOKEN no env do step. O instalador já grava tudo isso.