Masz gotowy skrypt w Pythonie i chcesz zachować jego kolejne wersje albo pokazać go innym? GitHub to serwis do przechowywania projektów opartych na Gicie, ale samo konto nie zastąpi pracy z historią zmian na komputerze. Różnica między tymi dwoma narzędziami przydaje się już przy pierwszym własnym repozytorium.

GitHub przechowuje projekty Git i ułatwia wspólną pracę nad kodem
- Git zapisuje historię zmian w plikach.
- GitHub hostuje repozytoria Git i udostępnia narzędzia do współpracy.
- Publiczne repozytorium może przeglądać każdy, a prywatne jest dostępne dla zaproszonych osób.
- Commit opisuje zapisany zestaw zmian, a pull request pozwala przedstawić zmiany do omówienia i scalenia.
- Hasła i klucze API trzymaj poza repozytorium, również prywatnym.
Git zapisuje zmiany, a GitHub udostępnia repozytorium
Wyobraź sobie, że poprawiasz skrypt i po chwili okazuje się, że poprzednia wersja działała lepiej. Git pozwala zapisywać historię projektu i wracać do wcześniejszych wersji plików; GitHub przechowuje repozytorium online oraz dodaje narzędzia do przeglądania i współpracy. To dwa różne elementy, choć często używa się ich razem.
Git jest rozproszonym systemem kontroli wersji. Oznacza to, że repozytorium sklonowane na komputer zawiera historię projektu, a nie tylko jego aktualny stan. Książka Pro Git opisuje tę różnicę, która przydaje się, gdy pracujesz bez połączenia z serwisem.
Repozytorium to katalog projektu wraz z historią zmian. W GitHubie możesz wybrać jego widoczność: publiczne repozytorium jest dostępne dla wszystkich, a prywatne dla Ciebie i osób, którym przyznasz dostęp. Ta decyzja dotyczy widoczności projektu, nie zastępuje jednak ostrożnego obchodzenia się z poufnymi danymi.
Commit, branch i pull request porządkują współpracę
W projekcie zespołowym łatwo pomylić „co zmieniono” z „co już przyjęto”. GitHub rozdziela te etapy: commit zapisuje porcję zmian, branch tworzy osobną linię pracy, a pull request przedstawia zmiany do przeglądu przed scaleniem. Ten porządek pomaga wychwycić błędy, zanim trafią do głównej wersji.
Przykład: poprawiasz obsługę błędów w aplikacji. Tworzysz branch, wprowadzasz zmianę i zapisujesz ją w commicie z opisem, na przykład „Dodano komunikat przy błędnym pliku”. Potem otwierasz pull request, by pokazać różnice i zebrać uwagi. Szybki start z pull requestami w dokumentacji GitHub pokazuje taki przepływ od utworzenia gałęzi po scalenie.
GitHub służy też do zgłaszania zadań i błędów przez Issues oraz organizowania pracy nad projektem. Przyznam, że w nauce programowania właśnie rozdzielenie zapisu zmian od ich omawiania porządkuje pojęcia bardziej niż zapamiętywanie samych nazw.
Pliki README i Issues zamieniają repozytorium w użyteczny projekt
Repozytorium z samymi plikami kodu może być czytelne dla jego autora, ale obce dla kolejnej osoby. README pełni funkcję instrukcji wejściowej: opisz w nim, do czego służy program, jak go uruchomić i czego potrzebuje. W projekcie Pythonowym podaj na przykład sposób instalacji zależności oraz komendę startową.
Issues przydają się do zapisywania błędów i pomysłów, a pull requesty do pokazywania proponowanych zmian. W repozytorium demonstracyjnym możesz zgłosić problem z formatem danych, a potem przygotować poprawkę na osobnej gałęzi. Przy prototypie aplikacji AR README może opisać wymagane urządzenie i sposób uruchomienia, jak przy pierwszym prototypie rzeczywistości rozszerzonej.
Jeżeli aplikacja rośnie, dokumentacja projektu może też wyjaśniać, skąd biorą się obiekty lub usługi potrzebne poszczególnym modułom. Przydatnym przykładem jest opis wstrzykiwania zależności w Pythonie, które pozwala przekazywać zależności do kodu bez konieczności korzystania z kontenera DI.
Wybierz publiczne lub prywatne repozytorium według zawartości
Jeśli chcesz pokazać ćwiczenia, portfolio albo projekt open source, publiczne repozytorium ułatwia innym dostęp do kodu. Gdy projekt zawiera nieopublikowaną pracę lub pliki przeznaczone dla zespołu, wybierz prywatne i przyznaj dostęp konkretnym osobom. Nie traktuj jednak prywatności jako sejfu na hasła.
Do repozytorium nie dodawaj tokenów, haseł ani kluczy API. Zapisz je poza kodem, na przykład w zmiennych środowiskowych, a w repozytorium umieść plik konfiguracyjny bez prawdziwych wartości. Dokumentacja GitHub Push protection opisuje mechanizm, który może blokować wysyłanie wykrytych sekretów, ale nie zastępuje kontroli plików przed publikacją.
| Sytuacja | Możliwy skutek | Co zrobić |
|---|---|---|
| Pokazujesz własne ćwiczenia lub otwarty projekt | Każda osoba może przeglądać pliki i historię | Ustaw repozytorium jako publiczne i dodaj README |
| Przechowujesz projekt zespołowy z ograniczonym dostępem | Osoby bez uprawnień nie zobaczą repozytorium | Ustaw widoczność prywatną i zaproś współpracowników |
| W pliku znalazł się token lub hasło | Samo usunięcie pliku z bieżącej wersji nie musi usunąć go z historii | Unieważnij sekret u dostawcy, usuń go z kodu i sprawdź historię repozytorium |
Na początek wystarczy jedno małe repozytorium
Gdy zaczynasz naukę, rozbudowany przepływ pracy może przytłaczać. Zacznij od repozytorium z jednym skryptem, krótkim README i kilkoma commitami. Jeśli pracujesz samodzielnie nad ćwiczeniem, zapisuj zmiany w Git; jeśli chcesz pokazać projekt lub współpracować, dodaj repozytorium na GitHubie.
Moim zdaniem początkujący najwięcej zyskuje, gdy nie czeka z GitHubem do ukończenia „poważnego” projektu. Mały skrypt wystarczy, by zobaczyć, jak opis commita pomaga odtworzyć tok pracy, a publiczny projekt może później stać się czytelnym portfolio.
