Tweet
Tweet

Slide 1

Slide 1 text

decodificando o CODE REVIEW

Slide 2

Slide 2 text

Elaine Naomi Watanabe twitter.com/elaine_nw speakerdeck.com/elainenaomi Desenvolvedora de Software (Plataformatec) Mestrado em Ciência da Computação (USP)

Slide 3

Slide 3 text

careers.plataformatec.com.br

Slide 4

Slide 4 text

expectativas: discutir os desafios e práticas da revisão de código

Slide 5

Slide 5 text

definição práticas do dia a dia desafios aprendizados

Slide 6

Slide 6 text

definição práticas do dia a dia desafios aprendizados

Slide 7

Slide 7 text

https://en.wikipedia.org/wiki/Code_review CODE REVIEW processo de verificação de um sistema por meio da análise do código fonte, realizada por humanos

Slide 8

Slide 8 text

https://en.wikipedia.org/wiki/Code_review CODE REVIEW processo de verificação de um sistema por meio da análise do código fonte, realizada por humanos

Slide 9

Slide 9 text

qual é o objetivo?

Slide 10

Slide 10 text

No content

Slide 11

Slide 11 text

2001

Slide 12

Slide 12 text

60% dos defeitos podem ser identificados na revisão do código Boehm, Barry, and Victor R. Basili. "Top 10 list [software development]." Computer 34.1 (2001): 135-137

Slide 13

Slide 13 text

2009

Slide 14

Slide 14 text

Revisão de código é uma boa ferramenta para identificar defeitos relacionados à evolutibilidade do código que não são identificáveis na fase de testes Mäntylä, Mika V., and Casper Lassenius. "What types of defects are really discovered in code reviews?." IEEE Transactions on Software Engineering 35.3 (2009): 430-448

Slide 15

Slide 15 text

Dívida Técnica Valor de negócio Custo da mudança tempo How to Monetize Application Technical Debt, Gartner, 2011

Slide 16

Slide 16 text

No content

Slide 17

Slide 17 text

http://agilemodeling.com/essays/modelReviews.htm Desenv. custo da mudança tempo Requisitos Análise e Design Revisão Testes Produção

Slide 18

Slide 18 text

http://agilemodeling.com/essays/modelReviews.htm Desenv. custo da mudança tempo Requisitos Análise e Design Revisão Testes Produção

Slide 19

Slide 19 text

QUALIDADE DE SOFTWARE Confiabilidade Corretude Eficiência Manutenabilidade Valor de negócio https://en.wikipedia.org/wiki/Software_quality

Slide 20

Slide 20 text

...

Slide 21

Slide 21 text

aprendizados definição práticas do dia a dia desafios

Slide 22

Slide 22 text

como fazer um code review?

Slide 23

Slide 23 text

como pessoa revisora

Slide 24

Slide 24 text

Pair Programming Pull Request

Slide 25

Slide 25 text

Pair Programming Pull Request

Slide 26

Slide 26 text

Fonte: https://mtlynch.io/human-code-reviews-2/

Slide 27

Slide 27 text

...

Slide 28

Slide 28 text

Pair Programming Pull Request código + contexto de negócio

Slide 29

Slide 29 text

Pair Programming Pull Request histórico acessível das discussões

Slide 30

Slide 30 text

interação assíncrona distribuída Mesmo local Mesmo tempo Tempo diferente Locais diferentes interação síncrona distribuída interação assíncrona interação face-a-face Johansen, Robert. "Groupware: Future directions and wild cards." Journal of Organizational Computing and Electronic Commerce 1.2 (1991): 219-227.

Slide 31

Slide 31 text

No content

Slide 32

Slide 32 text

revisão por meio de comentários

Slide 33

Slide 33 text

No content

Slide 34

Slide 34 text

transferência de conhecimento mentoria

Slide 35

Slide 35 text

visibilidade das alterações para outros times team awareness

Slide 36

Slide 36 text

boas práticas

Slide 37

Slide 37 text

como pessoa autora

Slide 38

Slide 38 text

Título explicativo Motivação (contexto de negócio) Lista de dúvidas e discussões prévias Gifs, screenshots das alterações

Slide 39

Slide 39 text

Mensagens de commits coerentes Código completo, testado Alterações pequenas Single responsibility principle

Slide 40

Slide 40 text

Marcar pessoas como revisoras Aplicar as alterações necessárias Responder a todos os comentários

Slide 41

Slide 41 text

...

Slide 42

Slide 42 text

como pessoa revisora

Slide 43

Slide 43 text

Identificar defeitos (bugs) Sugerir soluções alternativas, refatorações Reforçar padrões de código e design Validar funcionalidade (código + negócio)

Slide 44

Slide 44 text

Identificar problemas de segurança Analisar impactos na performance Sugerir documentações Validar a qualidade do código-fonte

Slide 45

Slide 45 text

Conhecer novas funcionalidades Aprender novas tecnologias Compartilhar conhecimento e dúvidas

Slide 46

Slide 46 text

...

Slide 47

Slide 47 text

definição práticas do dia a dia desafios aprendizados

Slide 48

Slide 48 text

Fonte: https://mtlynch.io/human-code-reviews-1/

Slide 49

Slide 49 text

2018

Slide 50

Slide 50 text

70% das alterações do Google são integradas em menos de 24h após o pedido de review Sadowski, Caitlin, et al. "Modern code review: a case study at Google." Proceedings of the 40th International Conference on Software Engineering: Software Engineering in Practice. ACM, 2018

Slide 51

Slide 51 text

Alterações pequenas, uma pessoa revisora e sem comentários além de autorização para integração Sadowski, Caitlin, et al. "Modern code review: a case study at Google." Proceedings of the 40th International Conference on Software Engineering: Software Engineering in Practice. ACM, 2018

Slide 52

Slide 52 text

mágica?

Slide 53

Slide 53 text

alinhamento

Slide 54

Slide 54 text

Sua base de código parece ter sido escrita por ÚNICA PESSOA? SIM NÃO Fonte: Talking with Tech Leads - Patrick Kua

Slide 55

Slide 55 text

collective code ownership https://martinfowler.com/bliki/CodeOwnership.html

Slide 56

Slide 56 text

Fonte: https://mtlynch.io/human-code-reviews-2/

Slide 57

Slide 57 text

quem faz review, faz parte da construção da solução também

Slide 58

Slide 58 text

como ir nessa direção?

Slide 59

Slide 59 text

...

Slide 60

Slide 60 text

como pessoa

Slide 61

Slide 61 text

...

Slide 62

Slide 62 text

lembre-se que o feedback deve ser sobre o código, e não sobre as pessoas

Slide 63

Slide 63 text

ninguém acorda e pensa: vou lá adicionar um bug e já volto

Slide 64

Slide 64 text

...

Slide 65

Slide 65 text

apoie a participação de TODAS AS PESSOAS do seu time

Slide 66

Slide 66 text

não é porque alguém é experiente, que não vai errar

Slide 67

Slide 67 text

não é porque alguém é iniciante, que não vai ter contribuição

Slide 68

Slide 68 text

...

Slide 69

Slide 69 text

use comentários explícitos e descritivos

Slide 70

Slide 70 text

No content

Slide 71

Slide 71 text

é para eu jogar fora a minha alteração?

Slide 72

Slide 72 text

ah, era só para apagar o espaço extra

Slide 73

Slide 73 text

...

Slide 74

Slide 74 text

comentários repetitivos sobre estilo de código

Slide 75

Slide 75 text

podem ser substituídos por uma ferramenta de análise de código

Slide 76

Slide 76 text

No content

Slide 77

Slide 77 text

No content

Slide 78

Slide 78 text

CÓDIGO: ELAINE 50% por 6 meses

Slide 79

Slide 79 text

...

Slide 80

Slide 80 text

melhorias de design podem ser entregues em outro pull request

Slide 81

Slide 81 text

...

Slide 82

Slide 82 text

se chegar a uma conclusão estiver difícil

Slide 83

Slide 83 text

não se limite à ferramenta de review

Slide 84

Slide 84 text

videoconferência presencialmente http://blog.plataformatec.com.br/2018/11/trabalhando-com-times-distribuidos/

Slide 85

Slide 85 text

documente as decisões e discussões offline

Slide 86

Slide 86 text

...

Slide 87

Slide 87 text

preste atenção na sua forma de se comunicar

Slide 88

Slide 88 text

muitas vezes não é óbvio que um comentário ou comportamento é prejudicial

Slide 89

Slide 89 text

...

Slide 90

Slide 90 text

como organização

Slide 91

Slide 91 text

...

Slide 92

Slide 92 text

tenha critérios bem definidos ex.: o número mínimo de aprovações

Slide 93

Slide 93 text

...

Slide 94

Slide 94 text

fator social

Slide 95

Slide 95 text

2014

Slide 96

Slide 96 text

Tsay, Jason, Laura Dabbish, and James Herbsleb. "Influence of social and technical factors for evaluating contribution in GitHub." Proceedings of the 36th international conference on Software engineering. ACM, 2014. Quando os testes estão incluso, o PR tem 17% mais chance de ser aceito fator técnico

Slide 97

Slide 97 text

Se a pessoa autora segue a pessoa responsável pelo projeto, tem 187% mais chance do PR ser aceito fator social Tsay, Jason, Laura Dabbish, and James Herbsleb. "Influence of social and technical factors for evaluating contribution in GitHub." Proceedings of the 36th international conference on Software engineering. ACM, 2014.

Slide 98

Slide 98 text

...

Slide 99

Slide 99 text

formalize as recomendações, crie guidelines sobre aspectos comportamentais

Slide 100

Slide 100 text

comunicação verbal, não verbal e escrita

Slide 101

Slide 101 text

No content

Slide 102

Slide 102 text

comportamentos tóxicos

Slide 103

Slide 103 text

COMPORTAMENTOS TÓXICOS https://medium.com/@jgefroh/toxic-developers-considered-harmful-f7ea1494d4c0 Impedem inovações e ideias Promovem a cultura da não-comunicação Colocam o projeto e negócio em risco por centralizar informação Comunicação agressiva (verbal, não-verbal e escrita)

Slide 104

Slide 104 text

"como assim você não sabe isso???"

Slide 105

Slide 105 text

"como deixaram você entrar aqui??"

Slide 106

Slide 106 text

"vou ter que te explicar de novo?"

Slide 107

Slide 107 text

A análise de sentimento em comentários tem mostrado evidências de que comentários com tom negativo tendem a ser menos úteis Sadowski, Caitlin, et al. "Modern code review: a case study at Google." Proceedings of the 40th International Conference on Software Engineering: Software Engineering in Practice. ACM, 2018

Slide 108

Slide 108 text

como evitar isso?

Slide 109

Slide 109 text

Faça reviews como seres humanos https://mtlynch.io/human-code-reviews-1/ https://mtlynch.io/human-code-reviews-2/

Slide 110

Slide 110 text

ask, don't tell

Slide 111

Slide 111 text

ok, é só perguntar

Slide 112

Slide 112 text

ok, é só perguntar

Slide 113

Slide 113 text

"Testes não são importantes pra vc?" pergunta sarcástica, com julgamento pessoal

Slide 114

Slide 114 text

"Testes não são importantes pra vc?" pergunta sarcástica, com julgamento pessoal

Slide 115

Slide 115 text

"Esse PR não pode ser mergeado" comentário opinativo, sem ação concreta, imperativo

Slide 116

Slide 116 text

"Esse PR não pode ser mergeado" comentário opinativo, sem ação concreta, imperativo

Slide 117

Slide 117 text

"Por que não criou uma nova classe?" pergunta com julgamento pessoal ainda "como você não pensou nisso?"

Slide 118

Slide 118 text

"Por que não criou uma nova classe?" pergunta com julgamento pessoal ainda "como você não pensou nisso?"

Slide 119

Slide 119 text

busque comentar de maneira construtiva

Slide 120

Slide 120 text

construtivo "O que você acha sobre extrair essa lógica para uma classe? Acredito que vai melhorar a legibilidade e reduzir a complexidade"

Slide 121

Slide 121 text

sem suposição, tom de sugestão "Não sei se você já analisou isso, mas será que não vale a pena criar uma nova classe para esse caso?"

Slide 122

Slide 122 text

...

Slide 123

Slide 123 text

definição práticas do dia a dia desafios aprendizados

Slide 124

Slide 124 text

desenvolvimento de software tem muito a ver com cultura

Slide 125

Slide 125 text

"A cultura não faz as pessoas, as pessoas fazem a cultura" Chimamanda Ngozi Adichie

Slide 126

Slide 126 text

No content

Slide 127

Slide 127 text

No content

Slide 128

Slide 128 text

olhe para o seu time

Slide 129

Slide 129 text

diversidade ajuda a estimular empatia

Slide 130

Slide 130 text

pode ajudar a reduzir comportamentos tóxicos

Slide 131

Slide 131 text

e impactar positivamente na inovação e lucro

Slide 132

Slide 132 text

https://assets.mckinsey.com/~/media/857F440109AA4D13A54D9C496D86ED58.ashx Diversidade de gênero: 21% mais chances de resultados acima da média do mercado Diversidade cultural e étnica: 33% mais chances de resultados acima da média do mercado

Slide 133

Slide 133 text

olhe também para o ambiente fatores não-técnicos

Slide 134

Slide 134 text

pressão, sobrecarga de atividades, experiência e contexto de negócio Baysal, Olga, et al. "The influence of non-technical factors on code review." 2013 20th Working Conference on Reverse Engineering (WCRE). IEEE, 2013.

Slide 135

Slide 135 text

a qualidade do software reflete todos esses fatores

Slide 136

Slide 136 text

impacta também no código escrito

Slide 137

Slide 137 text

código escrito é uma forma de comunicação

Slide 138

Slide 138 text

"Instead of imagining that our main task is to instruct a computer what to do, let us concentrate rather on explaining to human beings what we want a computer to do." Donald Knuth. "Literate Programming (1984)" in Literate Programming. CSLI, 1992, pg. 99.

Slide 139

Slide 139 text

code review é sobre cultura, pessoas, qualidade de software

Slide 140

Slide 140 text

e aí, como é o code review no seu dia a dia?

Slide 141

Slide 141 text

minhas referências

Slide 142

Slide 142 text

No content

Slide 143

Slide 143 text

No content

Slide 144

Slide 144 text

No content

Slide 145

Slide 145 text

No content

Slide 146

Slide 146 text

No content

Slide 147

Slide 147 text

No content

Slide 148

Slide 148 text

No content

Slide 149

Slide 149 text

No content

Slide 150

Slide 150 text

guidelines.plataformatec.com.br github.blog/2015-01-21-how-to-write-the-perfect-pull-request medium.com/palantir/19e02780015f medium.com/@jgefroh/f7ea1494d4c0 forbes.com/sites/quora/2014/11/07/10-characteristics-of-a-bad-softwar e-engineer blog.plataformatec.com.br/2018/07/como-evitar-silos-de-conhecimento- na-sua-codebase-e-levar-seus-code-reviews-para-o-proximo-nivel/

Slide 151

Slide 151 text

Building an Iconic Company - Reed Hasting youtube.com/watch?v=BsXXIfqbnRk A Arquitetura (Peculiar) do Stack Overflow - Roberta Arcoverde infoq.com/br/presentations/a-arquitetura-peculiar-do-stack-overflow Arquitetura, pragmatismo e simplicidade - Roberta Arcoverde docs.google.com/presentation/d/1DMpfVcXtALeCPwQwTM0Nz-YE1D Bz7hCvPMf8q6O1ogI/preview Talking with Tech Leads - Patrick Kua youtube.com/watch?v=dNE6aqkG7ss

Slide 152

Slide 152 text

Implementing a Strong Code-Review Culture - Derek Prior youtube.com/watch?v=PJjmw9TRB7s Maintaining a big open source project: lessons learned - Leonardo Tegon youtube.com/watch?v=rnOcDH_sgxg Integração Discreta: como melhorar a Integração Contínua e ainda ganhar em colaboração - George Guimarães infoq.com/br/presentations/integracao-discreta-como-melhorar

Slide 153

Slide 153 text

https://twitter.com/rla4/status/1097982806163185666

Slide 154

Slide 154 text

No content

Slide 155

Slide 155 text

muito obrigada speakerdeck.com/elainenaomi CÓDIGO: ELAINE 50% por 6 meses