Vídeo de PR
Um explicador de 40 a 100 segundos de um pull request, para alguém que não o lerá (geralmente um gerente): o que mudou,
por que, como funciona, o que é arriscado, o status e por onde um revisor deve começar. Técnico, mas simples.
Tudo é executado via CLI: node cli/prs.mjs <comando> a partir da raiz do repositório, ou
node <caminho para pr-studio>/cli/prs.mjs <comando> de qualquer lugar (abaixo: prs).
Início
- Ninguém assistindo (um job do GitHub Actions)? Leia guides/unattended.md primeiro: sem perguntas, um limite de tempo, uma rodada de revisão, para onde o resultado vai.
- Iniciado pelo Slack (@GitHub, uma sessão em nuvem)? Leia guides/slack.md primeiro: triagem, o orçamento de 59 minutos, postar cada vídeo na thread, e o que não fazer lá.
- Uma vez por máquina:
prs doctor(navegador, modelo de voz, Whisper, ffmpeg; ele apenas adiciona o que está faltando). - Depois leia guides/story.md e guides/visuals.md. Folheie catalog.md para ver os diagramas disponíveis.
Fluxo de trabalho (mire em 15-20 minutos)
- Buscar.
prs new <URL do PR>escrevevideos/<slug>/:brief.md(leia tudo),pr.diff(pesquise as linhas necessárias; não leia por inteiro),pr.jsone um esqueleto de storyboard com o número certo de batidas. - História. Escreva
videos/<slug>/storyboard.json: uma ideia por batida, umaneedpor batida, pistas e as afirmações com evidências (guides/story.md). Executeprs checkaté que ele diga pronto para prs voice. - Voz, em segundo plano. Inicie
prs voice(cerca de um minuto; MAI-Voice-2 quando uma chave Azure estiver configurada, senão a voz Kokoro local) e continue trabalhando enquanto ele é executado. - Direção.
prs directescolhe um tratamento para cada batida e o movimento do vídeo, escrevedirection.jsone gera o esqueleto descenes.jscom esses tratamentos. Preencha cada TODO a partir do PR. Mantenha as escolhas: elas são selecionadas para diferir de vídeos recentes. Se uma batida realmente não puder ser mostrada, reescolha-a comprs direct --use <batida>=<tratamento> --reason "..."(o motivo é registrado e revisado). - Visual.
prs stillsrenderiza quadros-chave ebuild/stills/contact.png. Abra a folha de contato e os quadros que importam e corrija o que vê. Os stills funcionam antes de a voz ficar pronta (timing provisório). - Verificação.
prs lintdeve reportar 0 problemas (layout, proveniência do texto, faixa de legenda, novidade, QR). - Renderizar e publicar.
prs render(segundos, quadros em cache), depoisprs publish: codificar, legendas, a verificação de sincronia (áudio vs legendas), entrega em~/Downloads/pr-videos/<slug>/e entrada na galeria. - Aprovação. Siga guides/review.md até que o agente
pr-directorrespondaVEREDITO: APROVADO; republicar após correções. - Entregar. Forneça o caminho do mp4, sua duração, um resumo de uma linha por batida, o veredito e o que você não pôde verificar (você não pode ouvir o áudio; a verificação de sincronia o mede).
Opcional: se o usuário pedir opções, adicione export const concepts = { beat, options: { a, b, c } } a
scenes.js e execute prs concepts: ele renderiza a batida de três formas lado a lado.
Regras
- Preciso ou ausente. Cada afirmação na narração e na tela deve vir do PR: seu corpo, commits, diff, testes ou código no commit head. Escreva as afirmações não testadas do autor como "de acordo com o autor". Sem suposições sobre intenção, sem marketing.
- Proveniência do texto. O texto da tela passa por
label()(suas palavras),fact()(números e nomes depr.json),quote()(texto exato do PR),ident()(nomes de código no diff),path()ecode().prepareverifica cada um contra o PR; números em umlabel()são sinalizados. - Um visual. Branco, paleta Microsoft, Aptos. Não adicione cores, fontes, fundos ou novos layouts dentro de um vídeo. O primeiro quadro (título) e o cartão final são fixos.
- Explicações diferentes. Nunca abra ou copie o
scenes.jsde outro vídeo; a galeria mantém apenas storyboards e folhas de contato. Se o catálogo não tiver um diagrama que o PR precisa, adicione um tratamento acatalog/(com demo,when, parâmetros, um still do catálogo viaprs catalog --stills, lint limpo) em vez de posicionar pixels manualmente. - Olhe o que você faz. Abra os stills e a folha de contato antes de dizer que algo funciona.
Comandos
prs new <url> | buscar o PR, escrever brief.md e um esqueleto de storyboard |
prs check | storyboard: janela de duração, pistas, placeholders, âncoras de evidência, dicas de pronúncia |
prs voice [--provider mai|kokoro|recording|silent] | narração + timing das palavras (com pausas ajustadas) |
prs direct [--use beat=treatment --reason ...] | escolher tratamentos e movimento; gerar esqueleto de scenes.js |
prs stills [--beat id] [--at 12.3,20] | quadros-chave + folha de contato |
prs lint [--every 0.5] | layout, proveniência, faixa de legenda, novidade, QR |
prs render / prs draft | quadros finais / uma prévia mp4 com metade do tamanho |
prs publish | codificar, legendas, verificação de sincronia, entrega, galeria |
prs catalog | todos os tratamentos com seus parâmetros |
prs triage <PRs> | --file f, prs summary, prs budget | quais PRs merecem um vídeo (execuções no Slack); a mensagem de encerramento; minutos restantes em uma sessão de nuvem |
prs history, prs report | vídeos recentes; onde o tempo foi gasto |
prs smoke | um vídeo demo curto do início ao fim, com timings: esta máquina está pronta? |