Hejto.pl
Hejto
/Wpisy
/Jak zrobić DOBRE code review? - devszczepaniak.pl
Jak zrobić DOBRE code review? - devszczepaniak.pl
Programowanie

Jak zrobić DOBRE code review? - devszczepaniak.pl

devszczepaniak.pl
elszczepano3
Code review, moim zdaniem powinien robić każdy członek zespołu. Oprócz aspektów związanych z rozwojem projektu jest to świetna okazja, by nie tylko pomóc innym stać się lepszymi, ale też, by samemu dowiedzieć się czegoś nowego. W najnowszym artykule na blogu przygotowałem zestaw rekomendacji i przemyśleń, które mogą pomóc Ci robić lepsze code review. Z artykułu dowiesz się:

Dlaczego uważam empatię za najważniejszy aspekt dobrego code review?
na jakie aspekty komunikacyjne warto zwrócić uwagę?
Na co zwracać szczególną uwagę a na co niekoniecznie?
Kiedy moim zdaniem warto lokalnie testować zmiany, a kiedy nie ma to sensu?
Na jakie błędy warto przymknąć oko?
Dlaczego warto spróbować code review w parze?

#programowanie
#informatyka
#programista15k
#frontend
#naukaprogramowania
#backend
3

Komentarze (3)

BilboBagosz

@elszczepano Z doświadczenia: ściągam też pull request i odpalam, gdy mam podejrzenie, że coś może nie działać, jeżeli tego testy nie pokrywają i jeżeli kod nie jest jasny po powierzchownym przejrzeniu. A co do "nitpicków" czy może drobnostek - to jest trochę dyskusyjna sprawa, u mnie w pracy np. formater ogarnia prawie wszystko tylko nie nowe linie, nowa linia totalnie nie zmieni działania kodu, ale czytelność już tak.

kodyak

Ja się nie przypierdalam ale to zależy od wielkości teamu i już czasu pracy z innymi. A że team jest mały i se możemy pogadać pomiędzy to w zasadzie code review to tylko niepotrzebna masturbacja

baklazan

@elszczepano świetny artykuł, zupełnie z Tobą się nie zgadzam! ; D


Przede wszystkim, empatia nie ma nic do rzeczy, poza tym, że nie powinieneś odnosić się do osoby tylko do kodu - "wczuwanie się w drugiego człowieka" to nie tylko bycie dla niego bardziej wyrozumiałym (co jest BŁĘDEM w code review), ale też traktowanie kodu jako "czyjegoś kodu", a przez to wyzywanie się na kimś, bo coś spieprzył.


Moim zdaniem ilość komentarzy w review nie powinna w żaden sposób zależeć od autora, a uwagi powinny dotyczyć kodu, a nie osoby. Tutaj nie ma miejsca na empatię!


Nie ma nic złego, by nawet w dużym pull requeście po prostu zostawić approve

Nie ma nic złego w ogólności. Ale sytuacja w której ktoś wrzuca duży kawałek kodu do review może oznaczać bardzo różne rzeczy, np że:

- robi proste porządki (poprawianie wcięć, usuwanie nieużywanych modułów), wtedy LGTM jest jak najbardziej ok,

- ktoś wrzuca w jednym commicie w cholerę zmian niezależnych od siebie, albo mnóstwo nowego kodu, wtedy danie approve'a "bo to nowicjusz", albo "bo empatia" jest co najmniej lekkomyślne


Moim zdaniem najważniejszym aspektem code review jest nie empatia a wymiana wiedzy między developerami. Jak wspomniałem wyżej, empatię należy zastąpić merytoryką, natomiast jeśli zadanie pytania w code review miałoby pomoc Tobie w zrozumieniu czyjegoś kodu, to powinieneś takie pytanie zadać. Jeśli widzisz w przez ciebie przeglądanym kodzie problem, powinieneś podzielić się tym spostrzeżeniem, bo tylko dzięki temu Ty, autor kodu albo osoby postronne mają szansę się czegoś nauczyć.


Oczywiście zakładając że nie piszesz bezsensownych elaboratów, albo osobistych wycieczek, ale to wynika z merytoryki, a nie empatii!


Efektem ubocznym jest lepiej napisany kod i lepsze opisy commitów. Ubocznym! : )

Zaloguj się aby komentować