Saltar para o conteúdo principal

Modelo de Pedido de Revisão de Código

Um modelo para solicitar revisões de código que dá aos revisores o contexto necessário para dar feedback útil.

GitHub Slack Discord

Preencha os marcadores entre parênteses retos com os seus detalhes.

O que este código faz: [Uma ou duas frases a explicar o propósito do código]

O que gostaria que fosse revisto: [Que feedback específico procura? Arquitetura? Desempenho? Casos extremos? Estilo?]

Contexto:

  • Linguagem/framework: [ex., TypeScript, React, Python/Django]
  • Ligação ao PR/diff: [ligação ao pull request ou código]
  • Tamanho: [número aproximado de linhas alteradas ou ficheiros afetados]

Decisões-chave que tomei:

  • [Porque escolheu esta abordagem em vez de alternativas]
  • [Quaisquer compromissos de que tem conhecimento]

Áreas sobre as quais não tenho a certeza:

  • [Partes específicas onde agradeceria mais escrutínio]
  • [Qualquer coisa que pareceu um workaround ou hack]

Como testar: [Instruções breves para executar ou verificar as alterações]

Enviar Feedback