Jak zrobić dobry code review?

Sprawne tworzenie stron internetowych czy aplikacji zależy od wielu czynników, od dobrej i szczegółowej listy wymagań od klienta czy także od zgranego zespołu programistów. Spróbuję dzisiaj przedstawić kilka zagadnień jak zrobić dobry code review.

Co to jest code review?

Jak sama nazwa wskazuje, code review jest przeglądem kodu pod względem różnych aspektów. Najlepszym sposobem jest przeprowadzenie dyskusji z kimś bardziej doświadczonym lub też w grupie osób. Dyskusja może przybrać formę przeglądania kodu krok po kroku lub też ogólnej dyskusji nad funkcjonalnościami. Jest to też dobry moment nad optymalizacją kodu.

Poproś o code review

Wyobraź sobie, że nadchodzi czas realizacji zadania i masz oddać gotowy moduł, komponent lub gotową stronę internetową. W idealnym świecie został ci powiedzmy tydzień roboczy do ustalonego terminu i zastanawiasz się czy wszystko zrobiłeś poprawnie – rozwiązaniem jest dobry code review.

Decydujesz się, aby zrobić owy przegląd kodu ze swoim współpracownikiem lub zespołem. Zatem czego możesz oczekiwać od takiego procesu:

1. Terminowości, bo przecież założyłeś oddanie projektu w terminie lub nawet wcześniej. Należy zebrać się możliwie szybko i rozpocząć omawianie prac w projekcie. Nie powinno wam zależeć na szybkim „klepnięciu” kodu, jednak na pogodzeniu jakości z terminowością.
2. Jakości kodu, to punkt, na który należy zwrócić szczególną uwagę. Dobrze napisany kod pozwoli szybko znaleźć ewentualne błędy. Także przejrzysty kod pomoże w osiągnięciu oczekiwanego rezultatu w postaci terminowego i bezbłędnego produktu dla klienta. W tym punkcie bardzo przydatną będzie wtyczka do VS Code – Prettier. Zachęcam do zapoznania się z nią i oczywiście używania. Do jakości kodu można z pewnością zaliczyć:
   • dobrze prowadzone repozytorium kodu, czyli częste i niewielkie commity,
   • także poprawnie nazywane i opisywane,
   • czytelny kod, ale także komentarze w kodzie,
3. Testów, które można pisać w trakcie pracy nad projektem lub napisać je po zakończeniu zgodnie z wytycznymi zebranymi od klienta. Ten punkt nie musi zależeć od Ciebie. To zadanie można oddelegować od testera (o ile taka osoba jest w zespole), który spojrzy na kod świeżym okiem. Stuprocentowe pokrycie kodu testami nie zawsze jest możliwe, jednak warto do tego usiąść.
4. Merytoryka – jest bardzo istotna na koniec prac w projekcie. Nie sztuką jest hejtować czyjąś pracę, przecież zależy Wam na wysokiej jakości kodu i pracy, prawda? Dyskusja powinna skupić się na rzeczowym podejściu do kodu i znalezienia optymalnego rozwiązania. Pochwalenie współpracownika też zawiera się w tym punkcie.

Są to punkty, które życzyłbym sobie jako idealny code review. Można oczywiście rozwinąć je o wiele więcej, jednak są to podstawy na dobry początek.

Rozmowa

Intensywne rozmowy są bardzo pomocne w czasie prowadzenia weryfikacji projektu. Dyskusja powinna być konkretna i rzeczowa, ale niezbyt długa, ponieważ istnieje ryzyko „odbiegnięcia” od istoty problemu.

Fakt istnienia wielu komentarzy do kodu może wskazywać, że prawdopodobnie istnieje pewne nieporozumienie w zespole. Komentarze w kodzie i w dyskusji powinny być konkretne i niepozostawiające wątpliwości.

Na koniec procesu weryfikacji śmiało można powoli wprowadzać luźniejsze aspekty zmierzające do podsumowania. Ba, można nawet wprowadzić element humorystyczny dla rozluźnienia atmosfery i docenienia pracy i zaangażowania obu stron.

Podsumowanie

Podsumowując przeprowadzony code review zawsze warto wyciągnąć wnioski na przyszłość. Dobrą praktyką jest również wprowadzenie bazy wiedzy, do której podczas review będziecie wpisywać zagadnienia przydatne w przyszłych projektach. To wszystko z pewnością przyspieszy Wam pracę oraz zapewni pozbawiony wad kod.