Decoding code review - Tech & Beers

Slide 1

Slide 1 text

DECODING CODE REVIEW Tech & Beers - 2022

Slide 2

Slide 2 text

Software Engineer/Developer (since 2008) B.Sc. in Computer Engineering M.Sc. in Computer Science ELAINE NAOMI WATANABE twitter.com/elaine_nw speakerdeck.com/elainenaomi

Slide 3

Slide 3 text

Software Engineer/Developer (since 2008) B.Sc. in Computer Engineering M.Sc. in Computer Science ELAINE NAOMI WATANABE twitter.com/elaine_nw speakerdeck.com/elainenaomi slides disponíveis

Slide 4

Slide 4 text

Software Engineer/Developer (since 2008) B.Sc. in Computer Engineering M.Sc. in Computer Science ELAINE NAOMI WATANABE twitter.com/elaine_nw speakerdeck.com/elainenaomi último evento presencial em março/2020 saudades 3

Slide 5

Slide 5 text

por onde esta palestra andou? Agile Trends The DevConf - São Paulo GURU SP Ada Lovelace Day - Curitiba Rubyconf Brasil - Trilha Codamos SourceLevel - Webinar 2019 - 2020

Slide 6

Slide 6 text

EXPECTATIVAS

Slide 7

Slide 7 text

EXPECTATIVAS discutir os desaﬁos e práticas da revisão de código

Slide 8

Slide 8 text

Quem aqui revisa código no dia a dia? É um processo importante para vocês?

Slide 9

Slide 9 text

...

Slide 10

Slide 10 text

DEFINIÇÃO PRÁTICAS DO DIA A DIA DESAFIOS APRENDIZADOS

Slide 11

Slide 11 text

PRÁTICAS DO DIA A DIA DESAFIOS APRENDIZADOS DEFINIÇÃO

Slide 12

Slide 12 text

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

Slide 13

Slide 13 text

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

Slide 14

Slide 14 text

No content

Slide 15

Slide 15 text

No content

Slide 16

Slide 16 text

qual é o objetivo?

Slide 17

Slide 17 text

No content

Slide 18

Slide 18 text

2001

Slide 19

Slide 19 text

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

Slide 20

Slide 20 text

2009

Slide 21

Slide 21 text

Revisão de código é uma boa ferramenta para identiﬁcar defeitos relacionados à evolutibilidade do código que não são identiﬁcá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 22

Slide 22 text

Slide 23

Slide 23 text

como é a evolução de um software?

Slide 24

Slide 24 text

é sempre fácil alterar uma base de código?

Slide 25

Slide 25 text

...

Slide 26

Slide 26 text

No content

Slide 27

Slide 27 text

Dívida Técnica Custo da mudança Tempo How to Monetize Application Technical Debt, Gartner, 2011

Slide 28

Slide 28 text

This is ﬁne.

Slide 29

Slide 29 text

e tudo bem mesmo faz parte

Slide 30

Slide 30 text

mas e se a gente nunca olhar para essa dívida técnica?

Slide 31

Slide 31 text

Valor de negócio Custo da mudança Tempo How to Monetize Application Technical Debt, Gartner, 2011

Slide 32

Slide 32 text

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

Slide 33

Slide 33 text

o processo de code review é uma forma de reduzir a dívida técnica

Slide 34

Slide 34 text

costuma ter um custo menor de mudança em relação à correção de defeitos em produção

Slide 35

Slide 35 text

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

Slide 36

Slide 36 text

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

Slide 37

Slide 37 text

e pode impactar positivamente na qualidade de software

Slide 38

Slide 38 text

QUALIDADE DE SOFTWARE Conﬁabilidade Corretude Eﬁciência Manutenabilidade Valor de negócio https://en.wikipedia.org/wiki/Software_quality

Slide 39

Slide 39 text

é sobre impacto a longo prazo!

Slide 40

Slide 40 text

é sobre impacto a longo prazo!

Slide 41

Slide 41 text

...

Slide 42

Slide 42 text

DEFINIÇÃO PRÁTICAS DO DIA A DIA DESAFIOS APRENDIZADOS

Slide 43

Slide 43 text

DEFINIÇÃO PRÁTICAS DO DIA A DIA DESAFIOS APRENDIZADOS

Slide 44

Slide 44 text

como fazer uma revisão de código?

Slide 45

Slide 45 text

Pair Programming Pull Request

Slide 46

Slide 46 text

Pair Programming Pull Request

Slide 47

Slide 47 text

Pair Programming Pull Request Merge Request or Change Request

Slide 48

Slide 48 text

No content

Slide 49

Slide 49 text

documento sobre uma alteração

Slide 50

Slide 50 text

título

Slide 51

Slide 51 text

descrição

Slide 52

Slide 52 text

pessoas revisoras

Slide 53

Slide 53 text

revisão por meio de comentários

Slide 54

Slide 54 text

No content

Slide 55

Slide 55 text

comparação do código atual com a alteração proposta

Slide 56

Slide 56 text

No content

Slide 57

Slide 57 text

...

Slide 58

Slide 58 text

por que usar pull requests?

Slide 59

Slide 59 text

Pair Programming Pull Request

Slide 60

Slide 60 text

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

Slide 61

Slide 61 text

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

Slide 62

Slide 62 text

No content

Slide 63

Slide 63 text

RubyConf 2018 - A Branch in Time https://www.youtube.com/watch?v=8OOTVxKDwe0

Slide 64

Slide 64 text

RubyConf 2018 - A Branch in Time https://www.youtube.com/watch?v=8OOTVxKDwe0 capture the why, not the what

Slide 65

Slide 65 text

...

Slide 66

Slide 66 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 67

Slide 67 text

Trabalho Remoto

Slide 68

Slide 68 text

No content

Slide 69

Slide 69 text

...

Slide 70

Slide 70 text

transferência de conhecimento mentoria

Slide 71

Slide 71 text

No content

Slide 72

Slide 72 text

visibilidade das alterações para outros times team awareness

Slide 73

Slide 73 text

No content

Slide 74

Slide 74 text

...

Slide 75

Slide 75 text

boas práticas

Slide 76

Slide 76 text

...

Slide 77

Slide 77 text

como pessoa autora

Slide 78

Slide 78 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 79

Slide 79 text

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

Slide 80

Slide 80 text

Revisar seu próprio PR Marcar pessoas como revisoras Aplicar as alterações necessárias Responder a todos os comentários

Slide 81

Slide 81 text

Dica: Templates de Pull Requests

Slide 82

Slide 82 text

https://help.github.com/pt/github/creating-cloning-and-archiving-repositories/creating-a-template-repository

Slide 83

Slide 83 text

...

Slide 84

Slide 84 text

como pessoa revisora

Slide 85

Slide 85 text

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

Slide 86

Slide 86 text

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

Slide 87

Slide 87 text

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

Slide 88

Slide 88 text

...

Slide 89

Slide 89 text

DEFINIÇÃO PRÁTICAS DO DIA A DIA DESAFIOS APRENDIZADOS

Slide 90

Slide 90 text

DEFINIÇÃO PRÁTICAS DO DIA A DIA DESAFIOS APRENDIZADOS

Slide 91

Slide 91 text

No content

Slide 92

Slide 92 text

...

Slide 93

Slide 93 text

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

Slide 94

Slide 94 text

...

Slide 95

Slide 95 text

visibilidade

Slide 96

Slide 96 text

Ferramentas para notiﬁcações de PRs Métricas de acompanhamento do projeto Monitoração de bugs

Slide 97

Slide 97 text

...

Slide 98

Slide 98 text

impacto no tempo de entrega

Slide 99

Slide 99 text

2018

Slide 100

Slide 100 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 101

Slide 101 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 102

Slide 102 text

mágica?

Slide 103

Slide 103 text

alinhamento

Slide 104

Slide 104 text

No content

Slide 105

Slide 105 text

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

Slide 106

Slide 106 text

...

Slide 107

Slide 107 text

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

Slide 108

Slide 108 text

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

Slide 109

Slide 109 text

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

Slide 110

Slide 110 text

como ir nessa direção?

Slide 111

Slide 111 text

...

Slide 112

Slide 112 text

como pessoa

Slide 113

Slide 113 text

...

Slide 114

Slide 114 text

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

Slide 115

Slide 115 text

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

Slide 116

Slide 116 text

...

Slide 117

Slide 117 text

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

Slide 118

Slide 118 text

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

Slide 119

Slide 119 text

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

Slide 120

Slide 120 text

...

Slide 121

Slide 121 text

use comentários explícitos e descritivos

Slide 122

Slide 122 text

No content

Slide 123

Slide 123 text

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

Slide 124

Slide 124 text

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

Slide 125

Slide 125 text

...

Slide 126

Slide 126 text

comentários repetitivos sobre estilo de código

Slide 127

Slide 127 text

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

Slide 128

Slide 128 text

No content

Slide 129

Slide 129 text

No content

Slide 130

Slide 130 text

No content

Slide 131

Slide 131 text

...

Slide 132

Slide 132 text

melhorias de design podem ser entregues em outro pull request

Slide 133

Slide 133 text

...

Slide 134

Slide 134 text

se chegar a uma conclusão estiver difícil

Slide 135

Slide 135 text

não se limite à ferramenta de review

Slide 136

Slide 136 text

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

Slide 137

Slide 137 text

videoconferência presencialmente ? https://blog.plataformatec.com.br/2018/11/trabalhando-com-times-distribuidos/ o que vocês acham?

Slide 138

Slide 138 text

No content

Slide 139

Slide 139 text

documente as decisões e discussões oﬄine

Slide 140

Slide 140 text

...

Slide 141

Slide 141 text

preste atenção na sua forma de se comunicar

Slide 142

Slide 142 text

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

Slide 143

Slide 143 text

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

Slide 144

Slide 144 text

leia sobre comunicação não-violenta muitas vezes não é óbvio que um comentário ou comportamento é prejudicial

Slide 145

Slide 145 text

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

Slide 146

Slide 146 text

...

Slide 147

Slide 147 text

como organização

Slide 148

Slide 148 text

...

Slide 149

Slide 149 text

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

Slide 150

Slide 150 text

atenção aos silos de conhecimento http://blog.plataformatec.com.br/2018/07/como-evitar-silos-de-conhecimento-na-sua-c odebase-e-levar-seus-code-reviews-para-o-proximo-nivel/ bus factor

Slide 151

Slide 151 text

...

Slide 152

Slide 152 text

fator social

Slide 153

Slide 153 text

2014

Slide 154

Slide 154 text

Tsay, Jason, Laura Dabbish, and James Herbsleb. "Inﬂuence 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 inclusos, o PR tem 17% mais chance de ser aceito fator técnico

Slide 155

Slide 155 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 156

Slide 156 text

...

Slide 157

Slide 157 text

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

Slide 158

Slide 158 text

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

Slide 159

Slide 159 text

No content

Slide 160

Slide 160 text

comportamentos tóxicos

Slide 161

Slide 161 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 162

Slide 162 text

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

Slide 163

Slide 163 text

"como deixaram você entrar aqui??"

Slide 164

Slide 164 text

"vou ter que te explicar de novo?"

Slide 165

Slide 165 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 166

Slide 166 text

como evitar isso?

Slide 167

Slide 167 text

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

Slide 168

Slide 168 text

ask, don't tell

Slide 169

Slide 169 text

ok, é só perguntar

Slide 170

Slide 170 text

ok, é só perguntar

Slide 171

Slide 171 text

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

Slide 172

Slide 172 text

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

Slide 173

Slide 173 text

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

Slide 174

Slide 174 text

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

Slide 175

Slide 175 text

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

Slide 176

Slide 176 text

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

Slide 177

Slide 177 text

busque comentar de maneira construtiva

Slide 178

Slide 178 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 179

Slide 179 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 180

Slide 180 text

...

Slide 181

Slide 181 text

DEFINIÇÃO PRÁTICAS DO DIA A DIA DESAFIOS APRENDIZADOS

Slide 182

Slide 182 text

DEFINIÇÃO PRÁTICAS DO DIA A DIA DESAFIOS APRENDIZADOS

Slide 183

Slide 183 text

desenvolvimento de software tem muito a ver com cultura e comunicação

Slide 184

Slide 184 text

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

Slide 185

Slide 185 text

olhe para o seu time

Slide 186

Slide 186 text

diversidade ajuda a estimular empatia

Slide 187

Slide 187 text

pode ajudar a reduzir comportamentos tóxicos

Slide 188

Slide 188 text

e impactar positivamente na inovação e lucro

Slide 189

Slide 189 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 190

Slide 190 text

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

Slide 191

Slide 191 text

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

Slide 192

Slide 192 text

a qualidade do software reﬂete todos esses fatores

Slide 193

Slide 193 text

impacta também no código escrito

Slide 194

Slide 194 text

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

Slide 195

Slide 195 text

Donald Knuth. "Literate Programming (1984)" in Literate Programming. CSLI, 1992, pg. 99. "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."

Slide 196

Slide 196 text

code review é sobre cultura, pessoas, qualidade de software

Slide 197

Slide 197 text

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

Slide 198

Slide 198 text

...

Slide 199

Slide 199 text

https://sourcelevel.io/code-review-ebook

Slide 200

Slide 200 text

...

Slide 201

Slide 201 text

minhas referências

Slide 202

Slide 202 text

No content

Slide 203

Slide 203 text

No content

Slide 204

Slide 204 text

google.github.io/eng-practices/review/reviewer/standard.html

Slide 205

Slide 205 text

No content

Slide 206

Slide 206 text

No content

Slide 207

Slide 207 text

No content

Slide 208

Slide 208 text

No content

Slide 209

Slide 209 text

No content

Slide 210

Slide 210 text

github.com/joho/awesome-code-review 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 211

Slide 211 text

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

Slide 212

Slide 212 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 213

Slide 213 text

https://sandimetz.com/blog/2016/1/20/the-wrong-abstraction

Slide 214

Slide 214 text

All the little things - Sandi Metz https://www.youtube.com/watch?v=8bZh5LMaSmE

Slide 215

Slide 215 text

...

Slide 216

Slide 216 text

No content

Slide 217

Slide 217 text

Lessons Learned from Elixir Learning Paths https://www.youtube.com/watch?v=I1jUWz1RP2U https://speakerdeck.com/elainenaomi/elixir-conf-eu-lessons-learned-from-elixir-learning-paths

Slide 218

Slide 218 text

...

Slide 219

Slide 219 text

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

Slide 220

Slide 220 text

...

Slide 221

Slide 221 text

railsgirls.com.br

Slide 222

Slide 222 text

No content

Slide 223

Slide 223 text

No content

Slide 224

Slide 224 text

No content

Slide 225

Slide 225 text

CARNIVAL EDITION

Slide 226

Slide 226 text

No content

Slide 227

Slide 227 text

speakerdeck.com/elainenaomi elainenaomi.dev Muito obrigada illustrations from undraw.co