GitHub to jedno z najpopularniejszych narzędzi używanych przez programistów na całym świecie do zarządzania kodem źródłowym.
Jednym z kluczowych aspektów pracy z GitHubem jest przegląd kodu (code review). Pozwala on na podniesienie jakości kodu i współpracę w zespole. Poniżej znajdziesz kompletny przewodnik, jak efektywnie wykorzystać GitHub do przeglądów kodu. Specjalnie w wersji dla osób, które dopiero zaczynają swoją przygodę z tym narzędziem.
Krok 1: Jak zacząć z GitHubem?
W pierwszej kolejności, przed przystąpieniem do przeglądu kodu należy założyć konto na GitHubie. W dalszej kolejności niezbędnym jest zrozumienie podstawowych pojęć, takich jak repozytoria, gałęzie (branches) i zatwierdzenia (commits). Repozytorium to nic innego jak projekt, nad którym pracujesz. Gałęzie pozwalają na pracę nad różnymi funkcjonalnościami bez zakłócania głównej linii kodu (master branch).
Krok 2: Tworzenie i zarządzanie pull requestami
Pull request (PR) to propozycja zmian, które chcesz wprowadzić do głównej gałęzi projektu. Aby utworzyć PR, musisz:
- Stworzyć nową gałąź i wprowadzić w niej potrzebne zmiany.
- Wysłać gałąź do repozytorium na GitHubie (git push).
- Utworzyć pull request przez interfejs GitHuba, wybierając opcję ‘New pull request’ oraz wybierając swoją gałąź.
- Pamiętaj, aby opisać co dokładnie zmieniasz i dlaczego. To bardzo ważne dla zrozumienia przez innych członków zespołu.
Krok 3: Komentowanie i dyskusja nad kodem
Po utworzeniu pull requesta inni członkowie zespołu mogą przejrzeć Twoje zmiany, a także komentować konkretne linijki kodu i sugerować poprawki. To esencja tego jak efektywnie wykorzystać github do codereview. Przy każdym komentarzu masz opcję odpowiedzi, co z kolei pozwala na dynamiczną dyskusję i szybkie wprowadzanie poprawek.
Podczas przeglądu pull requesta, każda zmieniona lub dodana linia kodu, jest wyświetlana w interfejsie przeglądarki w zakładce “Files changed”. Możliwość komentowania bezpośrednio przy konkretnych linijkach kodu pozwala na precyzyjne i skuteczne przekazywanie uwag.
Oto kroki, które umożliwią Ci przejście do okna dialogowego i dodanie komentarza:
- Otwórz pull request: Na liście pull requestów w repozytorium znajdź ten, który chcesz przejrzeć, a następnie kliknij w jego tytuł, aby przejść do szczegółów.
- Przejdź do zakładki “Files changed”: W górnej części strony pull requesta znajdują się różne zakładki takie jak “Conversation”, “Commits”, “Checks”, i “Files changed”. Kliknij na “Files changed”. Tutaj wyświetlone zostaną wszystkie pliki, które zostały zmienione w ramach pull requesta, wraz z dokładnymi różnicami przedstawionymi przez zielone (dodane) i czerwone (usunięte) linie.
- Znajdź interesującą Cię linijkę kodu: Przewiń przez listę zmian, aby znaleźć konkretną linijkę, do której chcesz dodać komentarz. Możesz korzystać z narzędzi filtrowania lub wyszukiwania, aby szybciej znaleźć interesujący fragment kodu.
- Dodaj komentarz: Obok każdej linii kodu pojawi się ikona w kształcie plusa (+). Kliknij na tę ikonę obok linii, której dotyczy Twój komentarz. Po kliknięciu, pojawi się okno dialogowe, w którym możesz wpisać swój komentarz. Wpisz swoje uwagi, sugestie lub pytania dotyczące tej linii kodu.
- Opublikuj komentarz: Po wpisaniu komentarza masz dwie opcje:
Add single comment – opublikuje Twój komentarz od razu.
Start a review – pozwala dodać ten komentarz do zbioru innych komentarzy, które mogą być opublikowane razem po zakończeniu przeglądu.Wybranie opcji “Start a review” jest szczególnie przydatne, gdy planujesz dodać więcej komentarzy, ponieważ pozwala na ich grupowanie i wspólne opublikowanie, co sprawia, że proces przeglądu staje się bardziej uporządkowany i skoncentrowany. - Zakończenie review: Gdy zdecydujesz, że review jest kompletne, możesz zakończyć sesję. Z prawego górnego rogu możesz wybrać opcję „Finish your review”, a następnie zatwierdzić zmiany przez „Approve” lub poprosić o dodatkowe zmiany przez „Request changes”. To efektywny sposób na finalizację procesu, zanim zmiany zostaną scalone z główną gałęzią.
- Pamiętaj, że kluczem do skutecznego przeglądu kodu jest nie tylko dokładność, ale również sposób komunikacji. Bądź zawsze konstruktywny, konkretny i uprzejmy. Pamiętaj, że za każdym fragmentem kodu stoją ludzie, którzy, podobnie jak Ty, dążą do tworzenia najlepszych rozwiązań.
Krok 4: Zatwierdzanie zmian
Gdy wszystkie komentarze zostaną omówione i ewentualne poprawki wprowadzone, pull request może być zatwierdzony i zmiany mogą być scalone z główną gałęzią. GitHub oferuje funkcję ‘Merge pull request’, która automatycznie scala zmiany po zatwierdzeniu PR (Pull Request).
Podsumowanie
Przegląd kodu na GitHubie to nie tylko sposób na utrzymanie wysokiej jakości kodu. To także doskonała metoda na uczenie się od innych programistów i dzielenie się wiedzą. Pamiętaj, że kluczowe jest utrzymanie otwartej komunikacji, a także dbanie o pozytywną atmosferę w zespole. Każdy pull request to okazja do nauki i doskonalenia swoich umiejętności.
Zachęcamy do wypróbowania wskazówek obrazujących w praktyce jak efektywnie wykorzystać GitHub i przekonania się, w jak dużym stopniu może to ułatwić pracę nad Twoimi projektami programistycznymi!
