Code review

Code Review

Czyli przegląd zmian w kodzie źródłowym innych członków zespołu. Ogólnie sposób na poprawienie jakości kodu oraz wczesne wyeliminowanie błędów. Dzięki Code Review zespół może być na bieżąco ze zmianami wprowadzanymi przez pozostałych, co ułatwia rozszerzanie świadomości kodu. Przy code review możemy przyjąć jedną z dwóch strategi :

  • Pre-commit  – kiedy to kod jest sprawdzany przed wprowadzeniem zmian do repozytorium kody
  • Post-commit – kiedy kod sprawdzany jest już po zmianach w repozytorium kodu

Pre-commit

W tym sposobie jak już wcześniej wspomniałem kod jest sprawdzany jeszcze przed zmianami w repozytorium. Takie podejście ma swoje wady i zalety. Największą zaletą jest to, iż kod w repozytorium zawsze jest już kodem sprawdzonym i nie będzie wymagał zmian związanych z utrzymaniem jakości. Moim zdaniem sposób ten jest idealny dla zespołów, gdzie występują duże różnice doświadczenia poszczególnych członków zespołu. Przy takim podejściu zespół musi być bardzo zdyscyplinowany, ażeby code review nie przeciągało się zbytnio. Im dłuższy czas pomiędzy zakończeniem implementacji a wprowadzeniem zmian, tym większe prawdopodobieństwo konieczności mergowania tychże zmian ze zmianami już wprowadzonymi w kodzie. A im więcej takich potencjalnych punktów spornych tym większa szansa, że coś się popsuje i implementacja przestanie działać poprawnie.

Post-commit

Tutaj zmiany są najpierw wprowadzane do repozytorium, a następnie sprawdzane. To podejście jest dobre dla zespołów, gdzie świadomość kodu jest porównywalna oraz dla kodu, który musi się szybko zmieniać. Umożliwia to szybsze wprowadzanie zmian. Niestety niesie za sobą to potencjalne problemy związane z  testami oraz koniecznością zmian po wykryciu błędów w czasie przeglądu kodu. Uważać również trzeba na zbytnie przeciąganie się samego procesu, gdyż w natłoku zadań może nie być chętnych do jego wykonania. Niemniej jednak strategia ta ułatwia zrobienie przeglądu kilku osobom. Idealnie sprawdza się, kiedy zmiany po code review mają charakter kosmetyczny.

Najważniejsze punkty

W procesie code review ważnych jest kilka zasad :

  • Przegląd powinien być wykonywany w miarę możliwości regularnie
  • Zmiany powinny być jak najbardziej atomiczne
  • Przegląd powinien być obiektywny i merytoryczne – nie powinniśmy zwracać uwagi na autora i naszej sympatii/antypatii do niego
  • Każda zmieniona, dodana czy usunięta linia powinna być sprawdzona pod kątem zasadności zmiany
  • Spokój i skupienie – przegląd wymaga skupienia i czasu,  nie powinniśmy się śpieszyć przy code review, a większe zmiany rozbić sobie na mniejsze iteracje

 

Dodaj komentarz

Twój adres email nie zostanie opublikowany. Pola, których wypełnienie jest wymagane, są oznaczone symbolem *