Processo: Revisão

• Introdução
• Revisão
• Casos Reabertos

Introdução

Neste documento se encontram as diretrizes para o processo de revisão de código colaborativa, que visa melhorar o código de  maneira conjunta e padronizada. Dando espaço para que todos os desenvolvedores tenham voz e compartilhem a responsabilidade de manter um código limpo e organizado.

Início do processo de revisão

Ao finalizar a implementação/correção do caso, o desenvolvedor deve atualizar o status do caso no Mantis e enviar a seguinte mensagem no canal revisao-em-pares no Rocket Chat:

Caso 43827 Link: https://mantis.supersoft.com.br/desenvol/view.php?id=43827 Branch: https://svn.supersoft.com.br/svn/desenvolvimento/branches/Esdras/Caso_0043827 À partir da revisão: 21426

Após o envio da mensagem, o desenvolvedor deve reagir à sua própria mensagem com o emoji de sino , para indicar que aquele caso merece atenção. (Basta pesquisar pelo emoji: “:bell:”)

 

Revisão

Ao iniciar a revisão de um caso, o desenvolvedor deve acessar o branch citado na mensagem e verificar as alterações feitas à partir da revisão indicada.
Caso todas as alterações estejam dentro dos padrões de código e não apresentem problemas de lógica ou inconsistências, o revisor deve responder¹ à mensagem informando que não identificou pontos à serem corrigidos.
Caso contrário, o revisor deve reagir à mensagem do caso com o emoji de exclamação (basta pesquisar por: “:exclamation:”) e responder¹ à mensagem da seguinte maneira: 

Unit: Exemplo.pas Linha: 100-10 Código como está: { Trecho do código enviado para revisão } Correção: { Código corrigido } || Explicação

Quando o segundo desenvolvedor concluir a revisão e não houver mais correções a serem feitas, o mesmo deve reagir à mensagem do caso com o emoji de “ certo ” (basta pesquisar por: “:white_check_mark:”) e responder¹ à mensagem inicial enviada anteriormente informando que a revisão foi feita e deve-se dar continuidade ao caso.

1. As mensagens referentes à correção de um caso devem ser feitas dentro de um tópico em resposta à mensagem inicial com as informações do caso. Estas mensagens não devem ser enviadas ao canal para não poluir visualmente o histórico de mensagens (Desmarcar o checkbox “Also send to channel”).

Casos Reabertos

Ao corrigir os pontos indicados na revisão, o responsável pelo caso deve reagir à mensagem inicial enviada anteriormente com o emoji de setas no sentido horário indicando que o caso está retornando (basta pesquisar por: “:arrows_clockwise:”) e responder¹ informando que a correção foi feita, requisitar uma nova correção do caso e indicar à partir de qual revision deve ser considerada.

A partir dessa etapa, o caso retorna para o processo de revisão.

Obs.: Ao observar que o caso retornou da correção, o desenvolvedor que reabriu o caso deve retirar sua reação de “exclamação”, mesmo que não revise naquele momento, para que não confunda com a correção encontrada na outra revisão.

1. As mensagens referentes à correção de um caso devem ser feitas dentro de um tópico em resposta à mensagem inicial com as informações do caso. Estas mensagens não devem ser enviadas ao canal para não poluir visualmente o histórico de mensagens (Desmarcar o checkbox “Also send to channel”).