GitHub - priama spolupráca v repozitári

Priama spolupráca cez GitHub je praktická, ak chcete pravidelne opravovať stránky, vytvárať nové Markdown súbory alebo pracovať s vaultom CircusWiki v editore ako Obsidian.

Ak chcete prispieť iba hrou, metódou, PDF-kom, odkazom alebo opravou, jednoduchší spôsob je zvyčajne lepší:

Späť na Prispieť

Čo potrebujete¶

• bezplatný účet na GitHub: https://github.com/join
• voliteľne GitHub Desktop: https://desktop.github.com/
• textový editor pre Markdown súbory, napríklad Obsidian, VS Code alebo jednoduchý editor

GitHub Desktop nie je povinný, ale pre mnohých ľudí je jednoduchší ako príkazový riadok.

Nájsť repozitár¶

Verejný repozitár sa nachádza tu:

https://github.com/nica-ev/circuswiki

Tam sa nachádzajú samotné Markdown súbory, obrázky, preklady a nástroje, z ktorých sa webová stránka zostavuje.

Pracovný postup v skratke¶

Typický postup je:

1. Vytvoriť fork repozitára na GitHub.
2. Naklonovať svoju kópiu na vlastný počítač.
3. Vykonávať zmeny v novom branche.
4. Upraviť súbory alebo vytvoriť nové Markdown súbory.
5. Committnúť zmeny.
6. Nahrať branch na GitHub.
7. Otvoriť Pull Request, aby bolo možné zmenu skontrolovať a prijať.

Krok za krokom s GitHub Desktop¶

1. Vytvoriť fork repozitára¶

Otvorte repozitár CircusWiki na GitHub:

https://github.com/nica-ev/circuswiki

Kliknite na Fork. Tým sa vytvorí vlastná kópia repozitára vo vašom účte na GitHub. V tejto kópii môžete pracovať bez priameho zásahu do hlavného projektu.

2. Naklonovať repozitár¶

Otvorte GitHub Desktop a vyberte:

File -> Clone repository...

Vyberte svoj fork nica-ev/circuswiki a určite priečinok na svojom počítači.

Potom budete mať lokálnu kópiu súborov.

3. Vytvoriť branch¶

Pre svoju zmenu je najlepšie vytvoriť vlastný branch, napríklad:

pridat-popis-hry
opravit-odkaz
nova-metoda-balancovanie

Branch udržuje vašu prácu oddelene od hlavného stavu. To uľahčuje neskoršiu kontrolu.

4. Upraviť súbory¶

Verejný obsah sa nachádza predovšetkým v jazykových priečinkoch pod docs/:

docs/de/
docs/en/
docs/es/
docs/pl/
...
docs/img/

Všetky jazyky sú rovnocenné. Neexistuje žiadny hlavný jazyk, v ktorom by sa mali prednostne vytvárať nové obsahy.

Ak vytvárate novú pôvodnú stránku, umiestnite ju do jazykového priečinka, v ktorom je text napísaný. Napríklad španielsky pôvodný text patrí do docs/es/, nemecký do docs/de/, anglický do docs/en/.

Dôležité je frontmatter na začiatku súboru. Tam musí byť zrejmé, že stránka je originál, napríklad:

translation_status: original
translation_source_lang: es

translation_source_lang zodpovedá jazyku pôvodného textu. Z tohto originálu sa neskôr môžu automaticky generovať preklady do všetkých podporovaných jazykov.

Pri úprave si všímajte nasledovné:

• Nezabudnite na začiatku súboru frontmatter.
• Pri nových pôvodných stránkach nastavte translation_status: original a príslušný translation_source_lang.
• Existujúce odkazy zachovajte, ak je to možné.
• Nezverejňujte žiadne súkromné údaje, API kľúče ani interné poznámky.
• Obrázky používajte len vtedy, ak sú licenčné práva jasné.
• Radšej robte malé, jasné zmeny ako veľmi veľké zmiešané zmeny.

5. Committnúť zmeny¶

V GitHub Desktop vidíte svoje zmenené súbory v sekcii Changes.

Napíšte krátke zhrnutie, napríklad:

Opraviť zoznam materiálu v pohybovej hre
Doplniť bezpečnostné upozornenie k Beigoma
Pridať nový popis hry

Potom kliknite na Commit to <branch-name>.

6. Nahrať zmeny¶

Kliknite na Push origin, aby ste nahrali svoj branch na GitHub.

7. Otvoriť Pull Request¶

GitHub Desktop alebo GitHub v prehliadači potom ponúkne možnosť vytvoriť Pull Request.

Pull Request znamená: navrhujete svoju zmenu pre hlavný repozitár. Zmena sa skontroluje, prípadne okomentuje a potom sa prijme alebo ďalej upraví.

Základy Markdown¶

Markdown je jednoduchý textový formát. Najdôležitejšie znaky postačujú pre väčšinu príspevkov:

# Veľký nadpis
## Podnadpis sekcie

Bežný text s **tučnou časťou** a *kurzívnou časťou*.

- Bod zoznamu
- Ďalší bod zoznamu

[Text odkazu](https://www.example.com)

Ak je niečo nejasné¶

Priamu spoluprácu cez GitHub nemusíte hneď dokonale ovládať. Ak otvoríte Pull Request a niečo ešte nie je v poriadku, dá sa to vyjasniť v revízii.

Ak chcete prispieť iba obsahom a technický postup sa vám zdá príliš náročný, jednoducho použite e-mail na stránke Prispieť.