Boas práticas para PRs e Code Reviews

Reflexões sobre como deixar o processo de code review mais eficiente por parte do autor de um Pull Request e de seu revisor.

Transcript

1. Boas práticas para PRs e Code Reviews ~pdf
2. Code Reviews são mais importantes do que você imagina... ...e não dar atenção para eles pode custar muito caro.
3. Não importa seu título, salário, sua marra, experiência, e nem seu ego ...Code Reviews são para TODOS!
4. Autor
5. #1 Você é o primeiro revisor do seu código Autor
6. #2 Faça de tudo para ter PRs com 400 LOC (máx) de alterações Autor
7. #3 Invista tempo na descrição do PR para não perder tempo com interrupções depois. Autor
8. #4 Deixe seu ego de lado. Esteja genuinamente aberto ao feedback do seu revisor. Autor
9. Revisor
10. #1 Revisão é um contrato de co-responsabilidade com o autor. Revisor
11. Reserve um tempo, foque e faça uma revisão completa. #2 Revisor
12. #4 Seja agradável na comunicação e assuma boa intenção do autor sempre. Revisor CONCISE FRIENDLY ACTIONABLE
13. #5 Evite Bikeshedding Revisor
14. #6 Priorize a forma como faz a revisão Revisor FUNCTIONAL CLEAN / MAINTAINABLE OPTIMIZED
15. #7 Acompanhe o PR depois da revisão. Revisor
16. #8 Use a revisão como uma oportunidade de compartilhar conhecimento Revisor
17. #9 Destaque o que está bom. (com GIFS divertidos) Revisor
18. #10 Preocupe-se com segurança. Revisor
19. - Pense em como você resolveria o problema - Tente identificar abertura para potenciais abstrações que podem deixar o código mais organizado ou reutilizável - Fique atento com adição/remoção de dependências. Avalie se elas são realmente necessárias e se são seguras - Avalie se a solução segue os padrões adotados (caso existam) - Verifique se o código adiciona ou reforça algum tipo de acoplamento ou piora alguma métrica de performance - Se questione se o código tem boa legibilidade - Avalie se o código quebra compatibilidade com alguma interface - Cheque se os testes escritos são suficientes - Atente-se para mudanças que necessitam de atualização da documentação Revisor
20. - Best Practices for Code Review - link - Effective Code Review Tips - link - Code Review Best Practices - link - 10 Principles of a Good Code Review - link - How to Give and Get Better Code Reviews - link - 5 Tips That'll Help You Become a Better Code Reviewer Today - link - 10 Simple Code Review Tips for Effective Code Reviews - link - 8 Tips for Great Code Reviews - link Referências