jest jak krytyka dania Twojej teściowej.
Musi być delikatne, żeby nie obrazić autora kodu/dania, ale na tyle dosadne, by wskazane błędy się nie powtórzyły.
Code review pozwala wyłapać błędy i niedociągnięcia w pracy wykonanej przez inną osobę, oraz wskazać gdzie konieczne jest wprowadzenie zmian.
To wyżej to taka książkowa definicja, ale tak na prawdę, przegląd kodu kolegi/koleżanki to także świetne narzędzie do monitorowania rozwoju danego programisty. Kiedy widzę, że ktoś popełnia mniej błędów niż wcześniej, już nie popełnia tych które popełniał i stosuje dobre praktyki, zamiast pisania potworków jakie się kiedyś zdarzały, to gęba sama mi się uśmiecha.
Z kolei mniej doświadczonym developerom, code review daje możliwość spojrzenia jak inni rozwiązują określone problemy.
Robiąc komuś code review:
- zapoznaj się z tytułem i opisem PRa oraz najlepiej opisem taska którego zmiana dotyczy, żeby orientować po co w ogóle zmiana była robiona
- Twoje uwagi powinny wyjaśniać problem i naprowadzać na właściwą ścieżkę, a nie tylko wskazywać, że kod jest zły i już
- nie czepiaj się drobiazgów, chyba że pozostawienie ich w kodzie niesie za sobą ponure konsekwencje
- pochwal za kreatywny lub nowatorski sposób rozwiązania problemu
- dobrą praktyką jest używanie formy pytającej: „czy nie było by prościej, gdyby zastosować tu funkcję xyz?”
- jeśli masz możliwość zrobienia code review kodu bardziej doświadczonego kolegi – zrób to. Może Cię coś zainspiruje. Może też znajdziesz przy okazji sposób na rozwiązanie danego problemu.
Nie wahaj się dodać swój komentarz swojemu sensejowi, jeśli coś Ci się w jego kodzie nie zgadza. Dobry programista doceni taki komentarz.
Jeśli ktoś robi code review Twojego kodu:
- dawaj do recenzji w miarę nieduże fragmenty kodu, tak by ich zrozumienie nie wymagało poświęcenia całego dnia
- dobrze nazywaj i opisuj PR’a wskazując na zakres wprowadzonych zmian
- przemyśl każdy otrzymany komentarz i przeanalizuj gdzie popełniłeś błąd. Upewnij się, że go zrozumiałeś. Jeśli nie rozumiesz uwagi – poproś o wytłumaczenie.
- nie stresuj się. Przegląd kodu to nic innego jak sprawdzenie jak poradziłeś sobie z zadaniem. Recenzent robi to po to, żeby pokazać Ci dobre praktyki i w konsekwencji zmniejszyć ilość roboty, którą gdyby nie Ty, musiałby wykonać samemu 🙂