O processo de revisão de código

Metas

Nosso processo de análise tem várias metas:

  • Garanta códigos de alta qualidade, tanto em termos de funcionalidade quanto de legibilidade.
  • Detectar bugs, porque bugs acontecem.
  • Mantenha um estilo consistente para que seja fácil começar a trabalhar em qualquer parte da base de código.

Todo o código incluído nas amostras blockly e o núcleo do Blockly passa por revisão, seja escrito por colaboradores da comunidade ou membros da equipe do Blockly.

Como avaliadores, nosso objetivo é trabalhar com você para fazer as melhores mudanças possíveis. Pedimos que vocês, como colaboradores, conversem conosco para que as solicitações de envio sejam analisadas e mescladas.

O processo

O processo de análise de relações públicas passa por algumas etapas:

  1. Atribuição
  2. Feedback
  3. Discussão
  4. Revisão
  5. Repetição
  6. Mesclar

Atribuição

Quando sua solicitação de envio chega, o membro de plantão da equipe da Blockly atribui um revisor.

Os revisores são escolhidos com base na experiência e para distribuir a carga de trabalho de maneira uniforme.

Pode levar alguns dias para que um revisor seja atribuído e mais alguns dias para ela ser concluída. Não se preocupe, isso é normal.

Feedback

Durante a etapa de feedback, o revisor deixa sugestões de mudanças em seu RP. Essas ações podem ser coisas simples para deixar seu código em conformidade com o Guia de estilo do JavaScript do Google. Ou podem ser coisas maiores, como pedir para você reorganizar as definições de função.

Os revisores são incentivados a usar as avaliações de código do GitHub, em vez de fazer comentários individuais, para que você receba uma única notificação, em vez de várias.

Discussão

A fase de discussão é a sua chance de responder ao feedback. Talvez um dos comentários não tenha ficado claro: agora é sua chance de pedir esclarecimentos. Ou talvez seu revisor tenha solicitado uma alteração, mas você acha que ela terá repercussões: agora é sua chance de encontrar um meio-termo.

Revisão

A fase de revisão é quando você faz alterações em seu PR. Normalmente, essas mudanças são resultado de algo que o revisor disse na fase de feedback.

Depois de concluir as revisões, inclua uma tag e peça para que o revisor analise novamente.

Repetição

Após a fase de revisão, o revisor tem outra chance de enviar feedback, e o processo começa do início.

Muitas vezes, uma segunda avaliação é simples e se concentra em detalhes, como pontuação e estilo de código. Mas, às vezes, uma segunda avaliação pode ser bem grande. O primeiro revisor pode até pedir a outra pessoa para dar uma olhada, para ter uma nova perspectiva.

Mesclar!

A fase de mesclagem é sua chance de comemorar. Você criou uma mudança, discutiu e revisou e finalmente a fundiu. Essa é uma grande conquista que muitas pessoas nunca começam, muito menos que concluam!

Agradecemos todo o seu trabalho árduo para melhorar a Blockly. E parabéns!