0 bodů

Git · 35 min

GitHub: fork, pull request a review

Jak se spolupracuje přes GitHub. Fork, větev pro změnu, pull request, code review a sloučení, synchronizace forku s původním projektem a jak napsat PR, který rád schválí každý.

Lidsky řečeno

Chceš opravit chybu v cizí knize. Do originálu v knihovně psát nesmíš. Uděláš si tedy vlastní kopii (fork), opravu v ní vyznačíš a autorovi pošleš žádost: „Podívej, tady jsem to opravil, převezmeš to?“ To je pull request. Autor ji přečte, napíše připomínky (review), ty je zapracuješ, a když je spokojený, opravu převezme do originálu.

Obtížnost: 3 z 5. Předpokládá větve, slučování a push/pull z předchozích lekcí. Webové rozhraní GitHubu v simulaci není, terminálové kroky si ale vyzkoušíš celé.

Dva způsoby spolupráce

  1. Jeden sdílený repozitář. Tým má do repozitáře právo zápisu. Každý pracuje ve vlastní větvi, pošle ji na server a otevře pull request do main. Tak to funguje ve většině firem.
  2. Fork. Do cizího (typicky open source) projektu zápis nemáš. Na GitHubu klikneš na Fork a vznikne tvoje kopie repozitáře pod tvým účtem. Do ní posíláš větve a pull request otevíráš z forku do původního projektu.

U forku máš dva vzdálené repozitáře. Zvykem je pojmenovat je takto:

  • origin: tvůj fork (https://github.com/ty/projekt.git), sem posíláš.
  • upstream: původní projekt (https://github.com/autor/projekt.git), odsud stahuješ novinky.
Úkol v terminálu

Naklonuj fork a připoj původní projekt

Udělal sis na GitHubu fork projektu https://github.com/sudo-learn/kucharka.git. Tvůj fork má adresu https://github.com/adam/kucharka.git. Naklonuj svůj fork a přidej původní projekt jako vzdálený repozitář se jménem upstream. Výsledek ověř přes git remote -v.

Načítám terminál…

Pull request krok za krokem

  1. Aktualizuj main (git pull, u forku synchronizace s upstreamem, viz níže).
  2. Vytvoř větev pro jednu konkrétní změnu: git switch -c oprava-preklepu.
  3. Commitni změnu (klidně ve více commitech).
  4. Pošli větev na svůj repozitář: git push -u origin oprava-preklepu. Git ti v odpovědi rovnou napíše odkaz na vytvoření pull requestu.
  5. Otevři pull request na GitHubu: vyber cílovou větev (obvykle main původního projektu), napiš název a popis.
  6. Review: ostatní okomentují konkrétní řádky, schválí (Approve), nebo požádají o změny (Request changes). Automatické testy (checks, GitHub Actions) ukážou, jestli kód prochází.
  7. Zapracuj připomínky: další commity do stejné větve a git push. Pull request se aktualizuje sám.
  8. Sloučení: správce klikne na Merge. Potom větev smažeš (GitHub na to nabídne tlačítko) a lokálně git switch main, git pull, git branch -d oprava-preklepu.
Úkol v terminálu

Připrav větev pro pull request

V receptu je překlep: místo Guláš je tam Gulás. Vytvoř větev oprava-preklepu, oprav v ní soubor gulas.txt na Guláš: maso, cibule, paprika, commitni se zprávou Opraven překlep v guláši a pošli větev na svůj fork (origin) s nastaveným sledováním.

Načítám terminál…

Synchronizace forku

Původní projekt jde dál a tvůj fork o tom neví. Novinky si stáhneš z upstream, sloučíš do svého main a pošleš do svého forku:

bash
git switch main
git fetch upstream
git merge upstream/main
git push origin main

(GitHub má pro totéž v rozhraní forku tlačítko Sync fork.)

Úkol v terminálu

Dožeň původní projekt

Do původního projektu mezitím autorka přidala recept na knedlíky. Tvůj main i tvůj fork ho nemají. Stáhni novinky z upstream, sluč je do svého main a pošli aktualizovaný main do svého forku.

Načítám terminál…

Dobrý pull request a dobré review

Jako autor:

  • Jeden PR = jedna změna. Malý PR (desítky řádků) se zkontroluje za pár minut, obří se odkládá týdny.
  • Název řekne co, popis proč a jak to vyzkoušet. U změn vzhledu přidej snímek obrazovky.
  • Odkaž na úkol: když v popisu napíšeš Closes #12 (nebo Fixes #12), GitHub po sloučení do výchozí větve úkol číslo 12 sám uzavře.
  • Nedokončenou práci otevři jako Draft pull request, ať ostatní ví, že ještě není k revizi.

Jako recenzent:

  • Komentuj kód, ne člověka. „Tady by se hodila kontrola prázdného vstupu“ místo „tohle je špatně“.
  • Rozliš, co je nutné a co jen návrh (třeba předponou „nit:“ pro drobnosti).
  • Ptej se, když něčemu nerozumíš. Otázka často odhalí chybu lépe než příkaz.
Pod kapotou · Ochrana větví, CODEOWNERS a CI

Správce může na main zapnout pravidla (branch protection rules nebo novější rulesets): zákaz přímého pushe, povinný počet schválení, povinné úspěšné kontroly CI a zákaz force push. Soubor CODEOWNERS určí, kdo musí schválit změny v určitých složkách. Pull request je ve skutečnosti jen záznam na serveru: „větev X chci sloučit do Y“. Git sám žádné pull requesty nezná, každá služba je dělá trochu jinak (GitLab jim říká merge request). Lokálně si cizí PR na GitHubu stáhneš přes git fetch origin pull/123/head:pr-123, pohodlněji přes GitHub CLI gh pr checkout 123.

Procvič si to

Kvíz

Co je fork?

Kvíz

Jak se u forku obvykle jmenuje vzdálený repozitář s původním projektem?

Kvíz

Po otevření PR ti recenzent napsal připomínku. Jak ji zapracuješ?

Kvíz

Co způsobí v popisu PR text Fixes #12?

Kvíz

Který způsob sloučení na GitHubu spojí všechny commity PR do jediného?

Spoj dvojice

Spoj krok s příkazem nebo akcí

Kartičky

Opakování: spolupráce na GitHubu