Mateusz Stanek

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

 

No related posts.

24 lutego 2018 MiroBurn Challange
No Comments

Przetwarzanie kolekcji z Linq to Object cz4

Trzeci tydzień blogowania – retrospekcja

Dodaj komentarz Anuluj pisanie odpowiedzi

Zobacz

  • Mateusz Stanek o mnie
Mateusz Stanek

Zaprzyjaźnione blogi

SGDev.pl

Ostatnie wpisy

  • Rola Prelegent
  • Elektronika – powrót do starego hobby
  • Badger2040
  • 2023 Tydzień 11
  • 2023 Tydzień 10

Najnowsze komentarze

  • Lukas L - Podsumowanie roku 2022
  • Oktawian Kurzynski - Enumeracja – wartość domyślna
  • Mateusz Stanek - Typy generyczne
  • Ola - Enumeracja – wartość domyślna
  • Typy generyczne w języku C# nie są 'rozwiązywane' w czasie kompilacji - Typy generyczne

Archiwa

  • marzec 2025
  • marzec 2023
  • luty 2023
  • styczeń 2023
  • grudzień 2022
  • marzec 2018
  • luty 2018
  • kwiecień 2017
  • marzec 2017
  • luty 2017

Kategorie

  • Bez kategorii
  • DSP2017
  • Elektronika
  • MiroBurn Challange
  • Narzędzia
  • Podsumowanie
  • Produktywność
  • Programowanie
  • Projekt
  • Prywatne
  • Rok 2023
  • Tips

Ostatnie wpisy

  • Rola Prelegent
  • Elektronika – powrót do starego hobby
  • Badger2040
  • 2023 Tydzień 11
  • 2023 Tydzień 10
Dumnie wspierane przez WordPressa | Motyw: Neblue by NEThemes.
Ta strona korzysta z ciasteczek aby świadczyć usługi na najwyższym poziomie. Dalsze korzystanie ze strony oznacza, że zgadzasz się na ich użycie.Zgoda
Privacy & Cookies Policy

Privacy Overview

This website uses cookies to improve your experience while you navigate through the website. Out of these cookies, the cookies that are categorized as necessary are stored on your browser as they are essential for the working of basic functionalities of the website. We also use third-party cookies that help us analyze and understand how you use this website. These cookies will be stored in your browser only with your consent. You also have the option to opt-out of these cookies. But opting out of some of these cookies may have an effect on your browsing experience.
Necessary
Always Enabled
Necessary cookies are absolutely essential for the website to function properly. This category only includes cookies that ensures basic functionalities and security features of the website. These cookies do not store any personal information.
Non-necessary
Any cookies that may not be particularly necessary for the website to function and is used specifically to collect user personal data via analytics, ads, other embedded contents are termed as non-necessary cookies. It is mandatory to procure user consent prior to running these cookies on your website.
SAVE & ACCEPT