Code Review

1) Czym jest Code Review?

2) Instrukcja otrzymania Code Review do zakupionego produktu

3) Instrukcja wykorzystaniu Code Review z pakietu

Czym jest Code Review?

Code Review (w skrócie CR, po polsku przegląd kodu) jest to praktyka stosowana w prawie każdej firmie, która wytwarza oprogramowanie. Polega ona na przekazaniu napisanego kodu innemu programiście do sprawdzenia (przeważnie programiście z większym doświadczeniem).

Zadaniem tej osoby jest sprawdzenie jakości kodu, sprawdzenie poprawności nazewnictwa zmiennych, funkcji, klas etc. oraz sprawdzenie czy w napisanym kodzie nie ma pozostałości po etapie developmentu (zbędne komentarze, nieużywane linie kodu, przypadkowe importy etc.). Osoba wykonująca CR zwraca również uwagę na styl pisania kodu, tak aby był on w całym projekcie spójny np. czy wcięcia są poprawnie zrobione, czy nie brakuje średników etc. Programista wykonujący CR może również dopatrzeć się miejsc, które można ulepszyć pod kątem wydajnościowym, stylistycznym lub funkcjonalnym. Po skończonym Review programista, do którego należy kod otrzymuje feedback (odpowiedź) od osoby, która je wykonała, dzięki temu wie co musi poprawić, ulepszyć, zmienić i jakich błędów nie popełniać.


Wykonując Code Review nie sprawdza się działania kodu!

Instrukcja otrzymania Code Review do zakupionego produktu

Aby otrzymać Code Review wybierz jeden z dwóch poniższych sposobów.
Pierwsza opcja jest trudniejsza ale profesjonalna, natomiast druga jest dla osób, które nie poradzą sobie z pierwszą.


Pierwszy sposób

Pierwszym sposobem jest otrzymanie Code Review poprzez zrobienie “merge request” na platformie GitLab.

Jeżeli nie wiesz jak zrobić "merge request", to pod tym linkiem znajdziesz instrukcję prosto z dokumentacji https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html.

  • Jeżeli jeszcze nie posiadasz konta na platformie GitLab to stwórz je.
  • Utwórz repozytorium, ważne aby w jego nazwie była zawarta nazwa produktu, do którego chce się otrzymać CR oraz numer zamówienia, w którym produkt został zakupiony np. cwiczenia-javascript-poziom-podstawowy-1-code-review-OGFDWMHPO.
  • W odpowiedzi na wysłanego do nas maila, o którym mowa na samym dole sekcji otrzymasz username naszego konta na GitLab. Dodaj nasze konto do swojego repozytorium z rolą “developer”.
  • Stwórz nowy branch z mastera / maina.
  • Wrzuć swój kod na nowo stworzonego brancha, zrób commit i push.
  • Z poziomu platformy GitLab zrób “merge request” twojego brancha do mastera / maina. W polu “Assignee” oraz “Reviewer” wybierz nasze konto, które wcześniej dodałeś do repozytorium.
  • GitLab sam poinformuje Cię o tym, że zaczęliśmy wykonywać dla Ciebie Code Review, poprzez maila, którego podałeś przy zakładaniu konta.

Drugi sposób

Skompresuj swój folder z kodem, a następnie dołącz go do maila, o którym mowa na samym dole sekcji. Jeżeli będziesz miał problem z wysłaniem skompresowanego folderu to możesz go wrzucić na dysk google i udostępnić link.


Po wybraniu sposobu otrzymania Code Review wyślij do nas wiadomość e-mail

Wiadomość e-mail wyślij na adres code-review-pl@quesflo.com.

Tytułem maila musi być nazwa produktu oraz numer zamówienia, w którym produkt został zakupiony.

W wiadomości napisz, który sposób otrzymania Code Review wybrałaś / wybrałeś.

Jeżeli będzie to opcja przez platformę GitLab, to w odpowiedzi na tego maila dostaniesz username naszego konta na tej platformie. Jeżeli to będzie druga opcja to w odpowiedzi otrzymasz swój kod wraz z naszymi komentarzami oraz feedbackiem.

Instrukcja wykorzystaniu Code Review z pakietu

Aby wykorzystać Code Review z pakietu, należy zrobić to samo co w sekcji "Instrukcja otrzymania Code Review do zakupionego produktu".

Dodatkowo w mailu do nas musi być dodana informacja, że chce się wykorzystać CR z pakietu oraz musi być podany numer zamówienia, w którym pakiet został zakupiony.

Cookies

Informujemy, iż w celu realizacji usług dostępnych w naszym sklepie, optymalizacji jego treści, dostosowania sklepu do Państwa indywidualnych potrzeb oraz wyświetlania, personalizacji i mierzenia skuteczności reklam w ramach zewnętrznych sieci reklamowych korzystamy z informacji zapisanych za pomocą plików cookies na urządzeniach końcowych użytkowników. Pliki cookies można kontrolować za pomocą ustawień swojej przeglądarki internetowej. Dalsze korzystanie z naszego sklepu internetowego, bez zmiany ustawień przeglądarki internetowej oznacza, iż użytkownik akceptuje stosowanie plików cookies. Więcej informacji zawartych jest w polityce prywatności sklepu.

Ustawienia cookies
Wymagane technicznie

Używamy plików cookie, aby umożliwić obsługę strony internetowej i zapewnić prawidłowe działanie niektórych funkcji. Śledzenie to jest zawsze aktywne, w przeciwnym razie nie będą mogli Państwo prawidłowo korzystać ze strony internetowej.

Marketing

Marketingowe pliki cookie są wykorzystywane przez strony trzecie lub wydawców do wyświetlania spersonalizowanych reklam. Odbywa się to poprzez śledzenie odwiedzających na różnych stronach internetowych.