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íme sdílený repozitář, se kterým se všichni budou synchronizovat.
Pro samostudium
Pokud materiály čteš z domu a máš možnost se v budoucnu dostat na nějaký sraz, zatím tuhle sekci přeskoč. Na sraze pak popros zkušenější programátory, aby ti pomohli. (Nechystáš-li se na sraz, můžeš pokračovat – zvládnout se to dá.)
Pro kouče
Udělej na GitHubu repozitář jménem prezencka a dej do
něj soubor se svým jménem. Příklad je na
encukou/prezencka.
Nasdílej s účastnicemi příkaz na jeho naklonování (přes https).
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ích svobod (převzato z Wikipedie):
- svoboda používat program za jakýmkoliv účelem,
- svoboda studovat, jak program pracuje a možnost přizpůsobit ho svým potřebám,
- svoboda redistribuovat kopie programu,
- 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)
- 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/frenzymadness/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žil/a, 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ý!
Posílání změn (git push)
Teď se do projektu zapoj.
Přidej soubor se svým jménem (nebo přezdívkou)
a dej ho do gitu (git add jmeno.txt, 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 naklonoval/a, 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 funguje tak, že vybraná skupina lidí má „přístup”: můžou dělat změny, jak se jim líbí.
S Gitem se používá jiný přístup: změny nahraješ do vlastního sdíleného repozitáře a majiteli původního projektu 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 mohli 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 záleží hlavně na samotné změně, ne na tom, kdo ji udělal.
Služba github.com ti umožňuje si udělat vlastní sdílený repozitář a zjednodušuje 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žil/a 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.
Kdybys měl/a v různých kopiích repozitáře zmatek, přijde vhod malé vysvětlení: jedna kopie je původní projekt na GitHubu, kam správce projektu dává aktuální „oficiální verzi“. Další kopie na GitHubu je „tvoje“ a můžeš si do ní nahrát co chceš (nejčastěji v ní ale zveřejňuješ změny, které můžou být užitečné pro ostatní). A třetí kopii repozitáře máš u sebe na počítači.
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/frenzymadness/prezencka (fetch)
origin https://github.com/frenzymadness/prezencka (push)
Tenhle výstup znamená, že pod zkratkou „origin” se schovává adresa, ze které jsi repozitář naklonoval/a.
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:frenzymadness/prezencka.git (fetch)
origin git@github.com:frenzymadness/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 master
což znamená: pošli na adresu uloženou pod zkratkou
tvojejmeno
větev master.
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žil/a na začátku pro
git clone).
Měl/a 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.
Jestli tlačítko Compare & pull request nevidíš, běž na adresu své kopie repozitáře a stiskni tlačítko New pull request. Vyber, co kam chceš začlenit, dopiš/změň popisek a pak zmáčkni Create pull request.
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.)
Pro samostudium
Procházíš-li materiály z domu, musíš teď počkat, než si někdo tvé žádosti všimne a začlení ji. To může trvat i pár dní; kdyby to bylo přes týden, tak se na stránce pull requestu zkus připomenout.
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.)
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.
Gratuluji! Právě jsi prošel/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 opravil/a. 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.
Některé projekty nepoužívají Issues na GitHubu. Kdybys záložku Issues nenašel/nenašla, podívej se do dokumentace projektu, jestli tam není odkaz na seznam chyb.
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. Není tedy například potřeba vysvětlovat v každém projektu, jak se instaluje Python. Stačí říct, že Python je potřeba (a v jaká verze) a odkázat uživatele na patřičný návod. Je také třeba brát v úvahu, kdo bude README číst. Píšete-li program pro jiné vývojářky a vývojáře, často není třeba zabrušovat do velikých 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.
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. Bez licence totiž nemá nikdo právo tvůj program ani používat, natož vylepšovat.
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.
Pokud chceš navíc zabránit tomu, že si tvůj kód někdo vezme a začne ho „vylepšovat“ a vydělávat na něm, aniž by se o vylepšení podělil s ostatními, zkus licenci AGPL.
A tyto materiály jsou pod ještě jinou licencí – CC BY-SA – protože výše jmenované licence jsou dělané na programy, ne na text.
Kód se nejčastěji licencuje tak, že text licence
dáš do souboru jménem LICENSE a přidáš do Gitu.
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.
{
"data": {
"sessionMaterial": {
"id": "session-material:2019/ostrava-git-workshop:git:3",
"title": "Spolupráce a Open source",
"html": "\n \n \n\n <h1>Spolupráce</h1>\n<p>„Opravdové” programy zřídka vznikají prací jednoho člověka.\nVíc hlav víc ví, a tak je dobré si na projekt vytvořit tým.</p>\n<p>Každý člen týmu potřebuje mít přístup k práci ostatních.\nK tomu se dá použít Git: někde na internetu si zařídíme <em>sdílený repozitář</em>,\nse kterým se všichni budou synchronizovat.</p>\n<div class=\"admonition note\"><p class=\"admonition-title\">Pro samostudium</p>\n<p>Pokud materiály čteš z domu a máš možnost se\nv budoucnu dostat na nějaký sraz, zatím tuhle sekci přeskoč.\nNa sraze pak popros zkušenější programátory, aby ti pomohli.\n(Nechystáš-li se na sraz, můžeš pokračovat –\nzvládnout se to dá.)</p>\n</div><div class=\"admonition note\"><p class=\"admonition-title\">Pro kouče</p>\n<p>Udělej na GitHubu repozitář jménem <code>prezencka</code> a dej do\nněj soubor se svým jménem. Příklad je na\n<a href=\"https://github.com/encukou/prezencka\">encukou/prezencka</a>.\nNasdílej s účastnicemi příkaz na jeho naklonování (přes https).</p>\n</div><h2>Open Source</h2>\n<p>Nejde mluvit o Gitu a spolupráci a nezastavit se chvíli u otevřeného\nzdrojového kódu.\nPrvní programy vznikaly v akademické sféře, kde byly zcela přirozeně sdíleny,\njako je to s poznatky mezi vědci běžné.\n50. a 60. léta byla obdobím velké kreativity, kdy vzniklo mnoho z konceptů\na technologií, které dnes používáme.\nPak se začalo programování postupně komercializovat a firmy začaly zdrojový\nkód skrývat jako konkurenční výhodu.\nDo té doby víceméně jednolitá komunita programátorů byla nucena se rozdělit.</p>\n<p>Některým programátorům tohle skrývání kódu hluboce vadilo.\nRoku 1985 publikoval\n<a href=\"https://en.wikipedia.org/wiki/Richard_Stallman\">Richard Stallman</a>\n<a href=\"https://www.gnu.org/gnu/manifesto.en.html\">GNU Manifesto</a>,\nkde vysvětlil, proč hodlá vytvořit operační systém s otevřeným kódem a\nodstartoval tak hnutí svobodného softwaru.\nTo prosazuje 4 následujících svobod (převzato\nz <a href=\"https://cs.wikipedia.org/wiki/Svobodn%C3%BD_software\">Wikipedie</a>):</p>\n<ol start=\"0\">\n<li>svoboda používat program za jakýmkoliv účelem,</li>\n<li>svoboda studovat, jak program pracuje a možnost přizpůsobit ho svým potřebám,</li>\n<li>svoboda redistribuovat kopie programu,</li>\n<li>svoboda vylepšovat program a zveřejňovat zlepšení, aby z nich mohla mít prospěch celá komunita.</li>\n</ol><p>Dnes je spousta projektů s otevřeným zdrojovým kódem (tzv. <em>open-source</em> projektů)\ndostupná na Internetu a každý je používáme.\nJejich další sdílení je upraveno jednou z licencí,\nkteré tyto základní svobody zaručují.</p>\n<p>Ne všechny jsou v Pythonu (a těm co jsou zatím\nnebudeš všem rozumět). Ne všechny jsou v Gitu.\nNe všechny jsou kvalitní – protože si\nkaždý může zveřejnit co chce, na Internetu se válí\nspousta nedodělků, opuštěných nápadů a nepodařených experimentů.\nA bohužel, ne všechny projekty mají přátelské autory.</p>\n<p>Na druhou stranu ale open-source programy\nmají svoje výhody: nejenom že se z nich může kdokoli\nučit, ale každý může i zkontrolovat, jestli\ndělají to, co dělat mají.\nPopulární open-source programy tě například\npravděpodobně nebudou špehovat (tj. hlásit autorovi,\nco na počítači děláš), ani většinou neobsahují\nreklamy: kdyby to dělaly, najde se\nněkdo kdo tyhle „funkce” odstraní a lidi – časem –\nzačnou používat opravenou verzi.</p>\n<p>Některé příklady populárních open-source projektů:</p>\n<ul>\n<li><a href=\"https://github.com/mozilla/gecko-dev\">Mozilla Firefox</a>,\n<a href=\"https://chromium.googlesource.com/chromium/src.git\">Chromium</a>\n(prohlížeče)</li>\n<li><a href=\"https://github.com/atom/atom\">Atom</a>,\n<a href=\"https://github.com/GNOME/gedit\">gedit</a>\n(textové editory)</li>\n<li><a href=\"https://github.com/python/cpython\">CPython</a>\n(jazyk Python)</li>\n<li><a href=\"https://github.com/torvalds/linux\">Linux</a>,\n<a href=\"https://github.com/aosp-mirror\">Android</a>\n(jádra operačních systémů)</li>\n<li><a href=\"https://github.com/pytest-dev/pytest/\">Pytest</a>\n(pythonní knihovna na testování)</li>\n<li><a href=\"https://github.com/django/django\">Django</a>,\n<a href=\"https://github.com/mitsuhiko/flask\">Flask</a>,\n<a href=\"https://github.com/kennethreitz/requests\">Requests</a>\n(webové knihovny pro Python)</li>\n<li><a href=\"https://github.com/numpy/numpy\">NumPy</a>,\n<a href=\"https://github.com/jupyter/notebook\">Jupyter</a>,\n<a href=\"https://github.com/matplotlib/matplotlib\">Matplotlib</a>\n(pythonní knihovny pro vědce a analytiky)</li>\n<li><a href=\"https://github.com/pyvec/naucse.python.cz\">Materiály</a> k tomuto kurzu</li>\n</ul>\n<p>Jak vidno z posledního příkladu, nejen softwarové\nprojekty se dají vést takhle veřejně.\nTento kurz vychází z principů open source:\nvšechno know-how je sdílené a budeme rádi, když\nse zapojíš.</p>\n<p>Až příště uvidíš v materiálech chybu (nebo jestli o nějaké víž už teď),\ndnes se dozvíš, jak ji opravit!</p>\n<p>A co tvůj kód? Chceš ho taky dávat takhle veřejně k dispozici?\nNutné to samozřejmě není – Git se dá používat i\nv uzavřeném týmu – ale na druhou stranu,\nmáš důvod proč to nedělat?\nZveřejňovat zdrojový kód se hodí už jen pro to,\naby ti s ním mohli zkušenější programátoři snadněji pomáhat.</p>\n<h2>GitHub</h2>\n<p>Na Internetu existuje spousta stránek, kam se dají nahrávat gitové repozitáře\ns kódem – např. <a href=\"https://gitlab.com/\">GitLab</a>,\n<a href=\"https://bitbucket.org\">BitBucket</a>,\n<a href=\"https://pagure.io/\">Pagure</a> nebo\n<a href=\"https://launchpad.net/\">Launchpad</a>.\nAktuálně nejpopulárnější je ale <a href=\"https://github.com\">GitHub</a>, který si tady\nukážeme.</p>\n<p>Jestli ještě nemáš uživatelský účet na <a href=\"https://github.com\">github.com</a>, jdi\ntam a založ si ho.</p>\n<h2>Naklonování repozitáře <small>(<code>git clone</code>)</small></h2>\n<p>Pro začátek zkusíme práci s repozitářem, který už vytvořil někdo jiný.\nV příkazové řádce zadej příkaz, který ti oznámí kouč; něco jako</p>\n<div class=\"highlight\"><pre><span></span><span class=\"gp\">$ </span>git clone https://github.com/frenzymadness/prezencka\n</pre></div><p>Vytvoří se ti nový repozitář – adresář se jménem\n<code>prezencka</code>, ve kterém je nějaký soubor.</p>\n<p>Na URL (adresu), kterou jsi v tomhle příkladě\npoužil/a, se můžeš podívat i v prohlížeči.\nUvidíš seznam souborů a spoustu odkazů k\ninformacím o repozitáři (například pod „commits”\nje historie).</p>\n<p>Přepni se do nového adresáře (<code>cd prezencka</code>)\na zkus se podívat na historii (<code>gitk</code> nebo <code>git log</code>).\nMožná je krátká, ale hlavně, že nějaká je.\nMáš na počítači kopii projektu, který založil někdo jiný!</p>\n<h2>Posílání změn <small>(<code>git push</code>)</small></h2>\n<p>Teď se do projektu zapoj.\nPřidej soubor se svým jménem (nebo přezdívkou)\na dej ho do gitu (<code>git add jmeno.txt</code>, <code>git commit</code>).</p>\n<p>Teď zbývá „jen” změnu začlenit do původního sdíleného repozitáře.\nTo ale není jen tak: repozitář, který jsi\nnaklonoval/a, patří koučovi. A tomu by se asi\nnelíbilo, kdyby kdokoliv na Internetu mohl přijít\na nahrát mu do repozitáře změny.</p>\n<p>Spousta míst na Internetu funguje tak, že vybraná\nskupina lidí má „přístup”: můžou dělat změny,\njak se jim líbí.</p>\n<p>S Gitem se používá jiný přístup:\nzměny nahraješ do <em>vlastního</em> sdíleného\nrepozitáře a majiteli původního projektu napíšeš\nžádost o začlenění těch změn (angl. <em>pull request</em>).\nMůže to být třeba mail se slovy „Hele, na té a té\nadrese mám nějaké změny, které by se ti mohli hodit!\nPřidej je do svého projektu!”</p>\n<p>Výhoda je v tom, že se do projektu – pokud je\nveřejný – může zapojit kdokoliv. Nemusíš se\npředem ptát, nemusíš dokazovat že jsi důvěryhodná\nosoba, stačí něco změnit a poslat.\nJestli se změna bude autorům projektu líbit nebo\nne, to už je jiná věc. Ale záleží hlavně na samotné\nzměně, ne na tom, kdo ji udělal.</p>\n<p>Služba <a href=\"https://github.com/\">github.com</a>\nti umožňuje si udělat vlastní sdílený repozitář a zjednodušuje\nzačleňování změn (místo posílání mailů stačí\nzmáčknout tlačítko). Pojďme se podívat, jak na to.</p>\n<p>Přihlaš se na GitHub a pak zajdi na adresu\nkterou jsi použil/a pro <code>git clone</code>.\nVlevo nahoře najdi tlačítko „Fork” a klikni na něj.\nTím si vytvoříš na GitHubu vlastní kopii repozitáře:\nadresa by měla být něco jako\n<code>https://github.com/<i>tvojejmeno</i>/prezencka</code>.</p>\n<div class=\"admonition note\"><p>Kdybys měl/a v různých kopiích repozitáře zmatek,\npřijde vhod malé vysvětlení: jedna kopie je původní\nprojekt na GitHubu, kam správce projektu dává\naktuální „oficiální verzi“. Další kopie na GitHubu\nje „tvoje“ a můžeš si do ní nahrát co chceš\n(nejčastěji v ní ale zveřejňuješ změny, které můžou\nbýt užitečné pro ostatní). A třetí kopii repozitáře\nmáš u sebe na počítači.</p>\n</div><blockquote><p><span class=\"figure\"><a href=\"/2019/ostrava-git-workshop/git/collaboration/static/gh-workflow-diagram.svg\"><img src=\"/2019/ostrava-git-workshop/git/collaboration/static/gh-workflow-diagram.svg\" alt=\"Diagram tří repozitářů\"></a></span></p>\n</blockquote>\n<p>A teď, jak z tvého počítače nahrát změny na GitHub?\nGit si u každého repozitáře na tvém počítači\npamatuje adresy, odkud se dají stahovat\na kam se dají posílat změny.\nSeznam těchhle adres ti ukáže příkaz <code>git remote -v</code>.\nTřeba:</p>\n<div class=\"highlight\"><pre><span></span><span class=\"gp\">$ </span>git remote -v\n<span class=\"go\">origin https://github.com/frenzymadness/prezencka (fetch)</span>\n<span class=\"go\">origin https://github.com/frenzymadness/prezencka (push)</span>\n</pre></div><p>Tenhle výstup znamená, že pod zkratkou „origin”\nse schovává adresa, ze které jsi repozitář\nnaklonoval/a.</p>\n<p>Přidej si podobnou zkratku pro vlastní repozitář na GitHubu.\nNezapomeň nahradit <i>tvojejmeno</i> za jméno účtu,\nkterý máš na GitHubu ty. (Pozor, v příkazu je <i>tvojejmeno</i> dvakrát!)</p>\n<div class=\"highlight codehilite\">\n<pre><code><span class=\"gp\">$</span> git remote add <i>tvojejmeno</i> https://github.com/<i>tvojejmeno</i>/prezencka\n</code></pre></div><p>a zkontroluj si, že se to povedlo:</p>\n<div class=\"highlight codehilite\">\n<pre><code><span class=\"gp\">$</span> git remote -v\n<span class=\"go\">origin git@github.com:frenzymadness/prezencka.git (fetch)</span>\n<span class=\"go\">origin git@github.com:frenzymadness/prezencka.git (push)</span>\n<span class=\"go\"><i>tvojejmeno</i> https://github.com/<i>tvojejmeno</i>/prezencka (fetch)</span>\n<span class=\"go\"><i>tvojejmeno</i> https://github.com/<i>tvojejmeno</i>/prezencka (push)</span>\n</code></pre></div><p>Tolik k nastavení – <code>git remote add</code>\nstačí udělat jednou pro každý repozitář.\nPak už můžeš změny nahrávat pomocí:</p>\n<div class=\"highlight codehilite\">\n<pre><code><span class=\"gp\">$</span> git push <i>tvojejmeno</i> master\n</code></pre></div><p>což znamená: pošli na adresu uloženou pod zkratkou\n<code><i>tvojejmeno</i></code>\nvětev <code>master</code>.</p>\n<p>Funguje? Podívej se na\n<code>https://github.com/<i>tvojejmeno</i>/prezencka</code>\nv prohlížeči a ujisti se, že tam tvoje změny jsou.</p>\n<h2>Žádost o začlenění <small>(<em>pull request</em>)</small></h2>\n<p>Teď zbývá požádat autory původního projektu,\naby změny z tvého sdíleného repozitáře přidali do svojí kopie.\nGitHub na to má mechanismus zvaný <em>pull request</em> (žádost o začlenění).</p>\n<p>Jdi na stránku původního projektu (na adresu,\nkterou jsi použil/a na začátku pro\n<code>git clone</code>).\nMěl/a bys tam vidět oznámení o své nově nahrané větvi\ns velkým zeleným tlačítkem <em>Compare & pull request</em>.\nKlikni na něj. Pokud chceš, tak dopiš/změň popisek\ntoho, co tahle změna obnáší.\nPak zmáčkni další tlačítko.</p>\n<div class=\"admonition note\"><p>Jestli tlačítko <em>Compare & pull request</em> nevidíš, běž na adresu\n<em>své</em> kopie repozitáře a stiskni tlačítko <em>New pull request</em>.\nVyber, co kam chceš začlenit, dopiš/změň popisek a pak zmáčkni\n<em>Create pull request</em>.</p>\n</div><p>Hotovo; teď je na autorech projektu, aby\nse na změny podívali a přijali – nebo začali diskusi\no tom, jak je ještě vylepšit.\n(Diskutovat se dá na stránce <em>pull requestu</em> nebo přes mail.)</p>\n<div class=\"admonition note\"><p class=\"admonition-title\">Pro samostudium</p>\n<p>Procházíš-li materiály z domu, musíš teď počkat,\nnež si někdo tvé žádosti všimne a začlení ji.\nTo může trvat i pár dní; kdyby to bylo přes týden,\ntak se na stránce <em>pull requestu</em> zkus připomenout.</p>\n</div><h2>Aktualizace <small>(<code>git pull</code>)</small></h2>\n<p>Když budou tvé změny – a změny od ostatních –\nzačleněné, můžeš si aktualizovat lokální repozitář. (To je ten,\nkterý máš u sebe na počítači.)</p>\n<p>To se dělá příkazem\n<code>git pull origin master</code> (stáhni změny\nz větve „master” z adresy pod zkratkou „origin”).\nPomocí <code>gitk --all</code> nebo <code>git log</code>\nse můžeš podívat, jak se projekt mezitím vyvinul.</p>\n<p>Gratuluji! Právě jsi prošel/prošla „kolečkem“,\nkteré většina programátorů dělá denně: udělání nějaké změny,\nodeslání kolegům na kontrolu a začlenění a stažení změn od ostatních.</p>\n<h2>Hlášení chyb <small>(<em>issues</em>)</small></h2>\n<p>Občas nastane situace, kdy v nějakém projektu\nna GitHubu najdeš chybu, ale nemáš čas nebo\nznalosti, abys ji opravil/a. V takovém případě\nčasto na GitHubu na stránce projektu pod záložkou <em>Issues</em>\nnajdeš seznam nahlášených problémů.\nNenajdeš-li mezi nimi „svoji” chybu, můžeš ji\nnahlásit – stačí kliknout na <em>New Issue</em>\na můžeš psát, kdy chyba nastává, co program dělá\nšpatně a co by měl dělat místo toho.</p>\n<div class=\"admonition note\"><p>Některé projekty nepoužívají Issues na GitHubu.\nKdybys záložku Issues nenašel/nenašla, podívej se\ndo dokumentace projektu, jestli tam není odkaz na\nseznam chyb.</p>\n</div><h2>README: Informace pro ostatní</h2>\n<p>Pokud vytváříš projekt a chceš, aby do něj přispívali i ostatní,\nje potřeba aby věděli, co tvůj projekt dělá, k čemu se hodí,\njak se používá a podobně.</p>\n<p>Na základní informace o projektu/repozitáři se používá soubor <code>README</code>\n(z angl. <em>read me</em>, <em>čti mě</em>).\nDo tohoto souboru patří mj.:</p>\n<ul>\n<li>název projektu,</li>\n<li>stručný popis projektu (jedna až dvě věty),</li>\n<li>krátký návod k instalaci projektu,</li>\n<li>krátký návod ke spuštění projektu,</li>\n<li>krátký návod k používání projektu, případně odkaz na rozsáhlejší dokumentaci,</li>\n<li>pokud má projekt testy, informace o tom, jak je spustit,</li>\n<li>informace o tom, jak se zapojit do vývoje projektu,</li>\n<li>informace o autorech projektu,</li>\n<li>informace o licenci (více se licencích dozvíš později).</li>\n</ul>\n<p>README by mělo být členěné a jeho přečtení by nemělo zabrat uživateli hodinu,\nvětšinou stačí krátké úderné informace s případným odkazem někam dál.\nNení tedy například potřeba vysvětlovat v každém projektu,\njak se instaluje Python.\nStačí říct, že Python je potřeba (a v jaká verze)\na odkázat uživatele na patřičný návod.\nJe také třeba brát v úvahu, kdo bude README číst.\nPíšete-li program pro jiné vývojářky a vývojáře,\nčasto není třeba zabrušovat do velikých detailů.</p>\n<p>GitHub (a spousty jiných podobných služeb) umožňuje pro README použít nějaký\nznačkovací jazyk, například <a href=\"https://cs.wikipedia.org/wiki/Markdown\">Markdown</a>.\nJe možné pak používat nadpisy, obrázky apod.</p>\n<p>V neposlední řadě – aby se do projektu mohl zapojit\nkdokoli z celého světa, bývají open-source projekty v angličtině.\nJména proměnných, komentáře, dokumentace – všechno\nje primárně v anglické verzi.\nTenhle kurz je česky, aby byly začátky jednodušší,\nale jestli se ti programování zalíbilo a chceš\nv něm po kurzu pokračovat dál, bez angličtiny\nto bude velice složité.</p>\n<h2>Licence</h2>\n<p>Aby sdílení fungovalo i pro právní stránce,\nnestačí když nahraješ kus kódu na Internet.\nMusíš taky oficiálně oznámit, že si s ním ostatní můžou hrát.\nBez <em>licence</em> totiž nemá nikdo právo tvůj\nprogram ani používat, natož vylepšovat.</p>\n<p>Problematika licencí může být, bohužel, docela složitá.\nKdyž to ale zjednodušíme na minimum, budeš\nchtít jen zajistit, aby každý mohl tvůj výtvor\npoužívat, učit se z něj, předávat ho dál\na vylepšovat ho. V tom případě vyber třeba\nlicenci <a href=\"https://choosealicense.com/licenses/mit/\">MIT</a>.</p>\n<div class=\"admonition note\"><p>Pokud chceš navíc zabránit tomu, že si tvůj kód\nněkdo vezme a začne ho „vylepšovat“ a vydělávat na\nněm, aniž by se o vylepšení podělil s ostatními,\nzkus licenci <a href=\"https://choosealicense.com/licenses/agpl-3.0/\">AGPL</a>.</p>\n</div><div class=\"admonition note\"><p>A tyto materiály jsou pod ještě jinou licencí –\n<a href=\"https://choosealicense.com/licenses/cc-by-sa-4.0/\">CC BY-SA</a> –\nprotože výše jmenované licence jsou dělané na programy, ne na text.</p>\n</div><p>Kód se nejčastěji licencuje tak, že text licence\ndáš do souboru jménem <code>LICENSE</code> a přidáš do Gitu.</p>\n<p>Chceš-li si o licencích přečíst něco víc, odkážu tě na\n<a href=\"http://choosealicense.com/\">choosealicense.com</a>,\npřípadně <a href=\"http://creativecommons.org/choose/\">creativecommons.org</a>\na <a href=\"https://opensource.org/licenses\">opensource.org</a>.</p>\n\n\n "
}
}
}