KIV/ZIM - Znalostní a informační management

h1. GitHub

h2. Co je GitHub a jak funguje?

GitHub je úložný prostor pro zdrojové kódy projektů. Je možné ukládat jak open-source, tak i soukromé projekty. Soukromé projekty ovšem většinou bývají za menší poplatek.

Github zároveň podporuje verzování, tedy ukládání změn v kódu a možnost kdykoliv se vrátit ke starší verzi.

Kromě samotného úložiště je GitHub využíván k práci více vývojářů na jednom projektu. Vývojáři mohou upravit zdrojový kód komunitního projektu (například psaní knihy s postupy a návody v Javascriptu) a pomocí Pull request zažádat o přidání změny do projektu.

Zvláštností GitHubu oproti jiným nástrojům pro sdílení informací je možnost zapojení celé komunity do projektu (pokud není projekt nastaven jako soukromý).

h2. Pro koho je GitHub určen?

Hlavní cílovou skupinou jsou programátoři. Může se jednat jak o nováčky, tak i o experty. Pro nováčky je GitHub vhodný, protože obsahuje mnoho tutoriálů a zdrojových kódů k velkému množství open-source projektů, ze kterých se mohou učit. Pro zkušenější programátory je GitHub určen také k přispívání do open-source projektů. Hlavní funkcionalitou, kterou využívají téměř všichni programátoři na GitHubu je samozřejmě možnost ukládání svých kódů do externího, verzovaného systému.

h2. Jaké informace lze na GitHubu nejlépe zachytit?

Jelikož hlavní funkcionalitou je ukládání zdrojových kódů, tak se jedná zejména o sdílení vlastních zdrojových kódů s komunitou. 

Na GitHubu se ovšem vyskytuje i velké množství různých tutoriálů a knih, na kterých komunita spolupracuje.

h2. Je možné jej propojit (integrovat) s dalšími nástroji?

GitHub je možné propojit například s komunikačním programem Slack, vývojářskými nástroji Visual Studio, Eclipse apod.

Zde je ukázka návodu integrace GitHubu se Slackem:

!slack.jpg!

h2. Ukázka vybraného projektu

!javascript.jpg!

V horní části projektu je menu. Nejdůležitějšími částmi menu projektu jsou tlačítka Code, Issues a Pull requests.

h3. Code

V této části je možné vidět veškeré schválené příspěvky do projektu. Běžně se zde nachází také Readme.md soubor s informacemi o projektu. Samozřejmostí jsou také zdrojové kódy projektu (nebo texty knihy, kterou komunita píše apod.)

V této sekci jsou také možné nejdůležitější funkce při práci na komunitním projektu, přispívat vlastními znalostmi a projekt tak rozšiřovat. Je možné vytvořit nový soubor v projektu (nebo ho nahrát), projekt stáhnout nebo ho naklonovat do svého GitHub účtu. Pomocí funkce New pull request je možné porovnávat dvě různé verze projektu a projekt aktualizovat a zažádat o přidání vaší aktualizace do projektu.

Dále se zde nachází tagy projektu pro přehlednější vyhledávání, počet příspěvků do projektu, počet vydání a počet přispěvatelů. Na tomto projektu se podílí celkem 363 lidí.

h3. Issues

!Javascript_issues.jpg!

Issues projektu složí přispěvatelům nebo jen čtenářům k popsání různých problémů, které se v knize vyskytují.

Většinou se jedná o drobné chyby v projektu, nebo jiné problémy s jejím obsahem. Například část knihy pojednávající o možném kódu pro řešení určité situace uživateli nefunguje, jak by měl. Místo opravení samotné knihy tedy založí vlákno v Issues s popisem problému, jelikož většinou bude chyba na straně uživatele.

h3. Pull requests

!Javascript_pull.jpg!

V sekci Pull requests jsou zobrazeny aktuální návrhy na aktualizaci projektu.

K jednotlivým příspěvkům je možné přidávat komentáře a když dojde ke shodě na návrhu, bude přiřazen k oficiální verzi projektu.

h2. Příklad využití

Při zobrazení zdrojového textu projektu je možné kliknout na editaci:

!{height: 6em; margin: 1em}(wiking shadow)new_fork.jpg!"(wiking button)Plná velikost":https://students.kiv.zcu.cz:3443/attachments/download/1504/new_fork.JPG

Následně se otevře stránka pro editaci obsahu :

!{height: 6em; margin: 1em}(wiking shadow)changes.jpg!"(wiking button)Plná velikost":https://students.kiv.zcu.cz:3443/attachments/download/1510/changes.JPG

V režimu editace je možné upravit nebo přidat další obsah. Po přidání změn do projektu je možné nechat web zobrazit změny oproti originálnímu souboru:

!{height: 6em; margin: 1em}(wiking shadow)preview.jpg!"(wiking button)Plná velikost":https://students.kiv.zcu.cz:3443/attachments/download/1511/preview.JPG

Původní řádek se zabarví červeně a přeškrtne se, pod ním se objeví zeleně změna, kterou jsme do projektu zapracovali.

Aby projekt nemohl kdokoliv měnit, přidávat do něj (i nezáměrně) chyby, nebo zcela projekt smazat, po uložení se změny v projektu vůbec neprojeví.

Místo samotného uložení změn do projektu je umožněn pouze návrh změny. Tento návrh se poté zobrazí ostatním členům komunity mezi ostatními Pull requests, kde dané změny mohou diskutovat a následné je změna schválena, zamítnuta nebo jsou požadovány dodatečné úpravy změny.

!{height: 6em; margin: 1em}(wiking shadow)propose_change.JPG!"(wiking button)Plná velikost":https://students.kiv.zcu.cz:3443/attachments/download/1512/propose_change.JPG

h2. Zdroje

https://get.slack.help/hc/en-us/articles/232289568-Use-GitHub-with-Slack

https://github.com/airbnb/javascript

----

h2. Komentáře

[P.Brada] Je rámcově vysvětlena funkčnost ale není popsán způsob práce s GitHub pro ne-softwarový obsah (zcela chybí popis wiki stránek); “definice” GitHub (“ úložný prostor pro zdrojové kódy projektů”) chybná, podobně “zvláštností je možnost zapojení komunity”; možnosti integrace popsány slabě; některé obrázky příliš velké, nevhodně pojmenovaná stránka (“přípona” -SP1).