Cultura de code review

Transcript

1. code review criando uma cultura saudável de
2. O que é code review? Revisão em grupo Pair programming Pull Request 1 3 2
3. Compartilhar conhecimento 1 Mentoria 2 Fomentar o debate 3 Importância do processo Mantém a cultura de qualidade Time: 5 minutes Assegurar qualidade 4
4. Coisas que não ajudam a criar um ambiente saudável de review
5. Passar uma opinião como um fato As pessoas precisam saber o motivo de uma solicitação de alteração de código, principalmente referente à estilo. A preferência pessoal de outro desenvolvedor não é um argumento bom o suficiente. Opte por passar referências de documentação. " Este componente deve ser sem estado. " " Uma vez que este componente não tem nenhum método de ciclo de vida ou estado, ele poderia se tornar um componente funcional sem estado. * Aqui * está alguma documentação. " RUIM BOM
6. Sobrecarregar a PR com muitos comentários As vezes não é necessário apontar cada ocorrência de um erro para não sobrecarregar a PR. É possível condensar em um comentário comreferências das linhas ou lugares que ocorre. " Espaço a mais " " Você dexou passar alguns trailing spaces nas linhas: 4, 12, 23 e 50. " RUIM BOM " Espaço a mais " " Espaço a mais " " Espaço a mais "
7. Pedir para resolver uma issue não relacionada à task Se uma mudança não faz farte do domínio ou não está diretamente relacionado à task, é preferível abrir um novo tíquete ou uma PR separada para lidar com o proboema. Isso evita aumentar drasticamente o escopo do trabalho de alguém. "Já que você está trabalhando nisso, pode alterar essa classe? Eu nunca gostei de como isso foi feito." " Parece bom o suficiente. Cria um novo ticket para refatorar a estrutura dessa classe." RUIM BOM
8. Fazer comentários sarcásticos Comentários sarcásticos não ajudam em nada no processo. Além de ser uma forma de comunicação passivo-agressiva, não é recomendável para quem está recebendo cŕiticas, pois não ajuda na confiança e auto crítica. Principalmente pada devs mais juniors. "Você ao menos testou seu código?" " Seu teste está falhando durante x, y e z. Para você pegar testes intermitentes tente rodar o rspec com --bisect. Favor revisar as ocorrências." RUIM BOM
9. Não responder todos os revisores Tente ajudar os revisores da sua PR. As pessoas tiram um tempo de desenvolvimento para revisar seu trabalho. Se você nem ao menos responde os comentários, as pessoas ficam se perguntando por que se preocuparam em ajudá-lo. Isso passa a mensagem de que algumas opiniões valem mais do que outras. RUIM
10. Criando um ambiente de review mais saudável
11. Use sugestões ou recomendações Nunca exija que as pessoas implementem mudanças ou faça perguntas em forma julgamento. Isso força a pessoa a se defender e não abre um diálogo. "Por que você não colocou isso em um arquivo de constantes?" "Tem muitas chamadas de tradução para o “recurso x” neste arquivo. Faz sentido criar um arquivo separado dedicado às constantes do “recurso x”." RUIM BOM
12. Respeitar e responder todos os comentários RUIM Responda todos os comendários, mesmo que você planeje não implementar uma sugestão. Respeite o tempo e o feedback dos seus revisores. BOM
13. Use reinforço positivo RUIM O papel da revisão de código não é somente tentar achar o máximo de bugs e erros em um código. Como uma ferramenta de promoção de discusão e boas práticas, também é importante destacar coisas positivas e que devem ser perpetuadas. BOM
14. Faça perguntas Debata Aponte as referências BOM Exercite a auto-crítica
15. auto-crítica Eu estou dedicando tempo suficiente para fazer uma review útil? Estou levando em consideração todos os feedbacks e usando a opotunidade para aprendizado? 1 2
16. “Num grupo, perde- se muito tempo quando as pessoas não estão certas de que tipo de reposta desejam em retorno as suas palavras” (ROSENBERG, 2006, p. 118) seja gentil
17. Referências Better Code Review Practices: https://dev.to/better-code-review- practices; Bob Fornal. Comunicação Não-Violenta; Marshall Roseberg. Unlearning toxic behaviors in a code review culture: https://medium.com/unlearning-toxic-behaviors-in-a-code-review; Sandya Sankarram .