Compartilhando conhecimento e unindo uma equipe por meio do code review VINÍCIUS BAIL ALONSO

Olá! EU SOU VINÍCIUS ALONSO Desenvolvedor Backend na CompuFácil Membro do PHP-SC

O QUE É CODE REVIEW? 1

“ É uma prática de revisão de trabalho de um programador antes de integrá-lo à base de código

QUAL O VALOR PARA MINHA EQUIPE? 2

COMPARTILHAMENTO DE CONHECIMENTO Centralizar o conhecimento em um único membro pode prejudicar sua equipe.

No content

CRIAÇÃO DE SOLUÇÕES ALTERNATIVAS PARA OS PROBLEMAS Debater nossas implementações é fundamental para melhorá-las.

public function totalValue() { $total = 0; foreach ($this->items as $item) { $total += $item->totalValue(); } return $total; }

public function totalValue() { $items = $this->items; return array_reduce($items, 'sum'); }

AUMENTO DO SENSO DE EQUIPE Se algo quebrar em produção de quem é a culpa?

No content

QUAIS SÃO OS PAPÉIS DOS ENVOLVIDOS? 3

AUTOR Quem implementou a feature, corrigiu o bug, etc e no fim enviou a PR.

Autor Responsabilidades: ◦ Escrever um código de qualidade; ◦ Resolver o problema conforme o requisito; ◦ Fornecer contexto

Fornecendo contexto .gitlab/merge_request_templates/feature.md

REVISOR Deve instigar um debate sobre o trabalho do colega por meio da argumentação lógica.

Revisor Responsabilidades: ◦ Perguntar, não dar ordens; ◦ Justificar as melhorias propostas; ◦ Ajudar com correções e mudanças

PONTOS CHAVE PARA UM REVIEW DE QUALIDADE 4

O que foi desenvolvido atende os requisitos? Melhor fazer errado a coisa certa do que fazer certo a coisa errada.

O que foi desenvolvido atende os requisitos? Pontos a considerar: ◦ Cuidar para não introduzir defeitos no software; ◦ Preferencialmente, não fazer tarefas ocultas em nossa PR;

O que foi desenvolvido atende os requisitos? Exemplo de requisito sem contexto

Os testes escritos garantem que o que foi implementado está realmente funcionando? Devemos ser capazes de ver os requisitos nos testes.

Os testes escritos garantem que o que foi implementado está realmente funcionando? Pontos a considerar: ◦ O testes devem cobrir os fluxos básicos; ◦ Tanto o caminho feliz como alguns caminhos de erro; ◦ Testes que não quebram não valem de nada

Os testes escritos garantem que o que foi implementado está realmente funcionando? public function testAddItem_shouldAddANewItem () { $product = new Product(['price' => 3000]); $item = new Item(['product' => $product, 'quantity' => 1]); $cart = new Cart(); $cart->addItem($item); $this->assertEquals( 1, $cart->countItems()); } Teste escrito com a biblioteca PHPUnit

Os testes escritos garantem que o que foi implementado está realmente funcionando? public function testAddItem_shouldAddTwoItems() { $product1 = new Product(['price' => 3000]); $item1 = new Item(['product' => $product1, 'quantity' => 1]); $product2 = new Product(['price' => 200]); $item2 = new Item(['product' => $product2, 'quantity' => 2]); $cart = new Cart(); $cart->addItem($item1); $cart->addItem($item2); $this->assertEquals(2, $cart->countItems()); } Teste que repete o conceito do anterior

A solução empregada foi a melhor para o momento? O código escrito foi atende o que precisamos agora, sem criar um débito técnico?

A solução empregada foi a melhor para o momento? Pontos a considerar: ◦ Clean Code ◦ YAGNI (you aren’t gonna need it) ◦ Arquitetura

No content

AGILIDADE 5

Uma das motivações do manifesto ágil “Individuals and interactions over processes and tools”

Alguns dos princípios do manifesto ágil “Working software is the primary measure of progress” “Continuous attention to technical excellence and good design enhances agility” “The best architectures, requirements, and designs emerge from self-organizing teams”

UMA FERRAMENTA 5

Uma ferramenta https://github.com/danger/danger

CONCLUSÃO

Conclusão Pontos: ◦ Code review traz muitos benefícios para sua equipe ◦ Devemos focar no que a máquina não pode fazer ◦ Para a prática acontecer de maneira saudável precisamos de indivíduos motivados a melhorar

Obrigado! PERGUNTAS? Você pode me encontrar Twitter: @alonsoemacao Github: @viniciusalonso Blog: https://medium.com/@vinciusalonso [email protected]

REFERÊNCIAS https://github.com/viniciusalonso/code-review-good-practices