Spolupráce

„Opravdové” programy zřídka vznikají prací jednoho člověka. Víc hlav víc ví, a tak je dobré si na projekt vytvořit tým.

Každý člen týmu potřebuje mít přístup k práci ostatních. K tomu se dá použít Git: někde na internetu si zařídí sdílený repozitář, se kterým se všichni budou synchronizovat.

Open Source

Nejde mluvit o Gitu a spolupráci a nezastavit se chvíli u otevřeného zdrojového kódu. První programy vznikaly v akademické sféře, kde byly zcela přirozeně sdíleny, jako je to s poznatky mezi vědci běžné. 50. a 60. léta byla obdobím velké kreativity, kdy vzniklo mnoho z konceptů a technologií, které dnes používáme. Pak se začalo programování postupně komercializovat a firmy začaly zdrojový kód skrývat jako konkurenční výhodu. Do té doby víceméně jednolitá komunita programátorů byla nucena se rozdělit.

Některým programátorům tohle skrývání kódu hluboce vadilo. Roku 1985 publikoval Richard Stallman GNU Manifesto, kde vysvětlil, proč hodlá vytvořit operační systém s otevřeným kódem a odstartoval tak hnutí svobodného softwaru. To prosazuje 4 následující svobody (převzato z Wikipedie):

0. svoboda používat program za jakýmkoliv účelem,
1. svoboda studovat, jak program pracuje a možnost přizpůsobit ho svým potřebám,
2. svoboda redistribuovat kopie programu,
3. svoboda vylepšovat program a zveřejňovat zlepšení, aby z nich mohla mít prospěch celá komunita.

Dnes je spousta projektů s otevřeným zdrojovým kódem (tzv. open-source projektů) dostupná na Internetu a každý je používáme. Jejich další sdílení je upraveno jednou z licencí, které tyto základní svobody zaručují.

Ne všechny jsou v Pythonu (a těm co jsou zatím nebudeš všem rozumět). Ne všechny jsou v Gitu. Ne všechny jsou kvalitní – protože si každý může zveřejnit co chce, na Internetu se válí spousta nedodělků, opuštěných nápadů a nepodařených experimentů. A bohužel, ne všechny projekty mají přátelské autory.

Na druhou stranu ale open-source programy mají svoje výhody: nejenom že se z nich může kdokoli učit, ale každý může i zkontrolovat, jestli dělají to, co dělat mají. Populární open-source programy tě například pravděpodobně nebudou špehovat (tj. hlásit autorovi, co na počítači děláš), ani většinou neobsahují reklamy: kdyby to dělaly, najde se někdo kdo tyhle „funkce” odstraní a lidi – časem – začnou používat opravenou verzi.

Některé příklady populárních open-source projektů:

• Mozilla Firefox, Chromium (prohlížeče)
• VS Code - OSS, Atom, gedit (textové editory)
• CPython (jazyk Python)
• Linux, Android (jádra operačních systémů)
• Pytest (pythonní knihovna na testování)
• Django, Flask, Requests (webové knihovny pro Python)
• NumPy, Jupyter, Matplotlib (pythonní knihovny pro vědce a analytiky)
• Materiály k tomuto kurzu

Jak vidno z posledního příkladu, nejen softwarové projekty se dají vést takhle veřejně. Tento kurz vychází z principů open source: všechno know-how je sdílené a budeme rádi, když se zapojíš.

Až příště uvidíš v materiálech chybu (nebo jestli o nějaké víž už teď), dnes se dozvíš, jak ji opravit!

A co tvůj kód? Chceš ho taky dávat takhle veřejně k dispozici? Nutné to samozřejmě není – Git se dá používat i v uzavřeném týmu – ale na druhou stranu, máš důvod proč to nedělat? Zveřejňovat zdrojový kód se hodí už jen pro to, aby ti s ním mohli zkušenější programátoři snadněji pomáhat.

GitHub

Na Internetu existuje spousta stránek, kam se dají nahrávat gitové repozitáře s kódem – např. GitLab, BitBucket, Pagure nebo Launchpad. Aktuálně nejpopulárnější je ale GitHub, který si tady ukážeme.

Jestli ještě nemáš uživatelský účet na github.com, jdi tam a založ si ho.

Naklonování repozitáře (git clone)

Pro začátek zkusíme práci s repozitářem, který už vytvořil někdo jiný. V příkazové řádce zadej příkaz, který ti oznámí kouč; něco jako

$ git clone https://github.com/naucse/prezencka

Vytvoří se ti nový repozitář – adresář se jménem prezencka, ve kterém je nějaký soubor.

Na URL (adresu), kterou jsi v tomhle příkladě použila, se můžeš podívat i v prohlížeči. Uvidíš seznam souborů a spoustu odkazů k informacím o repozitáři (například pod „commits” je historie).

Přepni se do nového adresáře (cd prezencka) a zkus se podívat na historii (gitk nebo git log). Možná je krátká, ale hlavně, že nějaká je. Máš na počítači kopii projektu, který založil někdo jiný!

Jak už napovídá název repozitáře, tvůj příspěvek do tohoto projektu bude zápis do prezenčky: konkrétně přidání souboru s tvým jménem. Jméno je to proto, aby nedocházelo ke kolizím: potřebujeme, aby příspěvky od všech lidí, kteří prochází tenhle kurz, byly jiné.

Tvůj příspěvek bude ovšem veřejně vystaven na internetu. Pokud nechceš vystavovat svoje občanské jméno, použij místo něj klidně přezdívku, oblíbené jídlo nebo pár náhodných písmen. Ale:

• když budeš pojmenovávat soubor, buď originální, aby nedošlo ke konfliktům, a
• nesdílej nic, co nemáš právo sdílet (např. texty moderních písní).

Vytvoření větve

Pomocí git branch zjisti, na jaké jsi aktuálně větvi. Měla by to být větev master.

Tuhle „základní“ větev je dobré používat jen na revize, na kterých se už shodl celý tým. Proto když chceš do projektu přispět, jako první krok si pro svůj příspěvek udělej novou větev a přepni se do ní. Například pomocí:

$ git branch pridani-jmena
$ git checkout pridani-jmena

Posílání změn (git push)

Teď se do projektu zapoj. Přidej soubor pojmenovaný podle tvého jména (nebo přezdívky) a dej ho do gitu (git add ...; git commit).

Teď zbývá „jen” změnu začlenit do původního sdíleného repozitáře. To ale není jen tak: repozitář, který jsi naklonovala, patří koučovi. A tomu by se asi nelíbilo, kdyby kdokoliv na Internetu mohl přijít a nahrát mu do repozitáře změny.

Spousta míst na Internetu (blogy, zpravodajství, e-shopy) funguje tak, že vybraná skupina lidí, „editorů“, má právo měnit obsah, jak se jim líbí. Takovým editorům musí správce projektu věřit, než jim přístup povolí.

S Gitem se používá trošku jiný mechanismus: změny nahraješ do vlastního sdíleného repozitáře, který máš právo měnit jen ty. Majiteli původního projektu pak napíšeš žádost o začlenění těch změn (angl. pull request). Může to být třeba mail se slovy „Hele, na té a té adrese mám nějaké změny, které by se ti mohly hodit! Přidej je do svého projektu!”

Výhoda je v tom, že se do projektu – pokud je veřejný – může zapojit kdokoliv. Nemusíš se předem ptát, nemusíš dokazovat že jsi důvěryhodná osoba, stačí něco změnit a poslat. Jestli se změna bude autorům projektu líbit nebo ne, to už je jiná věc – ale můžou posuzovat samotnou změnu, ne důvěryhodnost jejího autora.

Služby jako github.com ti umožňují si udělat vlastní sdílený repozitář (který bude k dispozici na internetu) a zjednodušují začleňování změn (místo posílání mailů stačí zmáčknout tlačítko). Pojďme se podívat, jak na to.

Přihlaš se na GitHub a pak zajdi na adresu kterou jsi použila pro git clone. Vlevo nahoře najdi tlačítko „Fork” a klikni na něj. Tím si vytvoříš na GitHubu vlastní kopii repozitáře: adresa by měla být něco jako https://github.com/tvojejmeno/prezencka.

A teď, jak z tvého počítače nahrát změny na GitHub? Git si u každého repozitáře na tvém počítači pamatuje adresy, odkud se dají stahovat a kam se dají posílat změny. Seznam těchhle adres ti ukáže příkaz git remote -v. Třeba:

$ git remote -v
origin  https://github.com/naucse/prezencka (fetch)
origin  https://github.com/naucse/prezencka (push)

Tenhle výstup znamená, že pod zkratkou „origin” se schovává adresa, ze které jsi repozitář naklonovala.

Přidej si podobnou zkratku pro vlastní repozitář na GitHubu. Nezapomeň nahradit tvojejmeno za jméno účtu, který máš na GitHubu ty. (Pozor, v příkazu je tvojejmeno dvakrát!)

$ git remote add tvojejmeno https://github.com/tvojejmeno/prezencka

a zkontroluj si, že se to povedlo:

$ git remote -v
origin  git@github.com:naucse/prezencka.git (fetch)
origin  git@github.com:naucse/prezencka.git (push)
tvojejmeno      https://github.com/tvojejmeno/prezencka (fetch)
tvojejmeno      https://github.com/tvojejmeno/prezencka (push)

Tolik k nastavení – git remote add stačí udělat jednou pro každý repozitář. Pak už můžeš změny nahrávat pomocí:

$ git push tvojejmeno pridani-jmena

což znamená: pošli na adresu uloženou pod zkratkou tvojejmeno větev pridani-jmena.

Funguje? Podívej se na https://github.com/tvojejmeno/prezencka v prohlížeči a ujisti se, že tam tvoje změny jsou.

Žádost o začlenění (pull request)

Teď zbývá požádat autory původního projektu, aby změny z tvého sdíleného repozitáře přidali do svojí kopie. GitHub na to má mechanismus zvaný pull request (žádost o začlenění).

Jdi na stránku původního projektu (na adresu, kterou jsi použila na začátku pro git clone). Měla bys tam vidět oznámení o své nově nahrané větvi s velkým zeleným tlačítkem Compare & pull request. Klikni na něj. Pokud chceš, tak dopiš/změň popisek toho, co tahle změna obnáší. Pak zmáčkni další tlačítko.

Hotovo; teď je na autorech projektu, aby se na změny podívali a přijali – nebo začali diskusi o tom, jak je ještě vylepšit. (Diskutovat se dá na stránce pull requestu nebo přes mail.)

U přidání jména do prezenčky se to asi nestane, ale kdybys potřebovala na změně před začleněním ještě trochu zapracovat (třeba i po pár dnech diskuse), nebyl by to problém. Přepni se na svém počítači do větve pridani-jmena, udělej další revize, a pomocí git push tvojejmeno pridani-jmena pull request aktualizuj.

Aktualizace (git pull)

Když budou tvé změny – a změny od ostatních – začleněné, můžeš si aktualizovat lokální repozitář. (To je ten, který máš u sebe na počítači.)

Nejdřív se přepni zpět do větve master. Teď už nebudeš pracovat na pridani-jmena; tahle větev už je odeslaná.

To se dělá příkazem git pull origin master (stáhni změny z větve „master” z adresy pod zkratkou „origin”). Pomocí gitk --all nebo git log se můžeš podívat, jak se projekt mezitím vyvinul.

Tohle git pull je dobré provést vždycky předtím, než začneš pracovat na nové změně/větvi. Zaručíš tím, že projekt, který měníš, je „čerstvý“.

Gratuluji! Právě jsi prošla „kolečkem“, které většina programátorů dělá denně: udělání nějaké změny, odeslání kolegům na kontrolu a začlenění a stažení změn od ostatních.

Hlášení chyb (issues)

Občas nastane situace, kdy v nějakém projektu na GitHubu najdeš chybu, ale nemáš čas nebo znalosti, abys ji opravila. V takovém případě často na GitHubu na stránce projektu pod záložkou Issues najdeš seznam nahlášených problémů. Nenajdeš-li mezi nimi „svoji” chybu, můžeš ji nahlásit – stačí kliknout na New Issue a můžeš psát, kdy chyba nastává, co program dělá špatně a co by měl dělat místo toho.

README: Informace pro ostatní

Pokud vytváříš projekt a chceš, aby do něj přispívali i ostatní, je potřeba aby věděli, co tvůj projekt dělá, k čemu se hodí, jak se používá a podobně.

Na základní informace o projektu/repozitáři se používá soubor README (z angl. read me, čti mě). Do tohoto souboru patří mj.:

• název projektu,
• stručný popis projektu (jedna až dvě věty),
• krátký návod k instalaci projektu,
• krátký návod ke spuštění projektu,
• krátký návod k používání projektu, případně odkaz na rozsáhlejší dokumentaci,
• pokud má projekt testy, informace o tom, jak je spustit,
• informace o tom, jak se zapojit do vývoje projektu,
• informace o autorech projektu,
• informace o licenci (více se licencích dozvíš později).

README by mělo být členěné a jeho přečtení by nemělo zabrat uživateli hodinu, většinou stačí krátké úderné informace s případným odkazem někam dál. Nemusíš tedy například vysvětlovat v každém projektu, jak se instaluje Python. Stačí říct, že Python je potřeba (a v jaké verzi) a odkázat uživatele na patřičný návod. Je také třeba brát v úvahu, kdo bude README číst. Píšeš-li program pro jiné vývojářky a vývojáře, často nemusíš zabrušovat do detailů.

GitHub (a spousty jiných podobných služeb) umožňuje pro README použít nějaký značkovací jazyk, například Markdown. Je možné pak používat nadpisy, obrázky apod.

A v neposlední řadě: aby se do projektu mohl zapojit kdokoli z celého světa, bývají open-source projekty v angličtině. Jména proměnných, komentáře, dokumentace – všechno je primárně v anglické verzi. Tenhle kurz je česky, aby byly začátky jednodušší, ale jestli se ti programování zalíbilo a chceš v něm po kurzu pokračovat dál, bez angličtiny to bude velice složité.

Licence

Aby sdílení fungovalo i pro právní stránce, nestačí když nahraješ kus kódu na Internet. Musíš taky oficiálně oznámit, že si s ním ostatní můžou hrát. Na svůj kód totiž máš autorské právo, podle kterého ostatní nesmí tvůj program používat, natož vylepšovat, dokud jim to nepovolíš. Pro formální udělení tohohle povolení se používají licence, které píšou právníci.

Problematika licencí může být, bohužel, docela složitá. Když to ale zjednodušíme na minimum, budeš chtít jen zajistit, aby každý mohl tvůj výtvor používat, učit se z něj, předávat ho dál a vylepšovat ho. V tom případě vyber třeba licenci MIT.

Kód se nejčastěji licencuje tak, že text licence dáš do souboru jménem LICENSE a přidáš do Gitu. Je dobré licenci zmínit i v souboru README.

Chceš-li si o licencích přečíst něco víc, odkážu tě na choosealicense.com, případně creativecommons.org a opensource.org.