GitHub - Přímá spolupráce v repozitáři

Přímá spolupráce přes GitHub je praktická, pokud chcete pravidelně opravovat stránky, vytvářet nové Markdown soubory nebo pracovat s trezorem CircusWiki v editoru, jako je Obsidian.

Pokud chcete přispět pouze hrou, metodou, PDF, odkazem nebo opravou, je jednodušší cesta obvykle lepší:

Zpět na Přispět

Co potřebujete¶

• bezplatný účet na GitHubu: https://github.com/join
• volitelně GitHub Desktop: https://desktop.github.com/
• textový editor pro Markdown soubory, například Obsidian, VS Code nebo jednoduchý editor

GitHub Desktop není povinný, ale pro mnoho lidí je jednodušší než příkazový řádek.

Najít repozitář¶

Veřejný repozitář najdete zde:

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

Zde se nacházejí skutečné Markdown soubory, obrázky, překlady a nástroje, ze kterých se sestavuje webová stránka.

Pracovní postup stručně¶

Typický postup je:

1. Vytvořit fork repozitáře na GitHubu.
2. Naklonovat svou kopii na vlastní počítač.
3. Provádět změny v novém branchi.
4. Upravit soubory nebo vytvořit nové Markdown soubory.
5. Potvrdit změny (commit).
6. Nahrát branch na GitHub.
7. Otevřít Pull Request, aby mohla být změna zkontrolována a přijata.

Krok za krokem s GitHub Desktop¶

1. Vytvoření forku repozitáře¶

Otevřete repozitář CircusWiki na GitHubu:

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

Klikněte na Fork. Tím se vytvoří vlastní kopie repozitáře ve vašem účtu na GitHubu. V této kopii můžete pracovat, aniž byste přímo měnili hlavní projekt.

2. Naklonování repozitáře¶

Otevřete GitHub Desktop a vyberte:

File -> Clone repository...

Vyberte svůj fork nica-ev/circuswiki a určete složku na svém počítači.

Poté budete mít lokální kopii souborů.

3. Vytvoření branch¶

Pro svou změnu je nejlepší vytvořit vlastní branch, například:

popis-hry-doplnit
opravit-odkaz
nova-metoda-balancovani

Branch udržuje vaši práci odděleně od hlavní verze. To usnadňuje pozdější kontrolu.

4. Úprava souborů¶

Veřejný obsah se nachází především ve složkách jazyků pod docs/:

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

Všechny jazyky jsou rovnocenné. Neexistuje žádný hlavní jazyk, ve kterém by se nový obsah měl primárně vytvářet.

Pokud vytváříte novou původní stránku, umístěte ji do složky jazyka, ve kterém je text napsán. Například španělský původní text patří do docs/es/, německý do docs/de/, anglický do docs/en/.

Důležité je frontmatter na začátku souboru. Zde musí být rozpoznatelné, že stránka je originál, například:

translation_status: original
translation_source_lang: es

translation_source_lang odpovídá jazyku původního textu. Z tohoto originálu lze později automaticky generovat překlady do všech podporovaných jazyků.

Při úpravách dbejte na následující:

• Nemazat frontmatter na začátku souboru.
• U nových původních stránek nastavit translation_status: original a odpovídající translation_source_lang.
• Stávající odkazy co nejvíce zachovat.
• Nezveřejňovat soukromá data, API klíče nebo interní poznámky.
• Obrázky používat pouze tehdy, jsou-li jasná práva k jejich užití.
• Raději provádět malé, jasné změny než velmi velké smíšené změny.

5. Potvrzení změn (commit)¶

V GitHub Desktop uvidíte své upravené soubory v sekci Changes.

Napište krátké shrnutí, například:

Opravit seznam materiálů v pohybové hře
Doplnit bezpečnostní pokyn k Beigoma
Přidat popis nové hry

Poté klikněte na Commit to <branch-name>.

6. Nahrání změn¶

Klikněte na Push origin, abyste nahráli svůj branch na GitHub.

7. Otevření Pull Requestu¶

GitHub Desktop nebo GitHub v prohlížeči poté nabídne vytvoření Pull Requestu.

Pull Request znamená: Navrhujete svou změnu pro hlavní repozitář. Změna bude zkontrolována, případně okomentována a poté přijata nebo dále upravena.

Základy Markdownu¶

Markdown je jednoduchý textový formát. Pro většinu příspěvků postačí nejdůležitější znaky:

# Velký nadpis
## Nadpis sekce

Běžný text s **tučnou částí** a *kurzivní částí*.

- Bod seznamu
- Další bod seznamu

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

Pokud něco není jasné¶

Přímou spolupráci přes GitHub nemusíte hned dokonale umět. Pokud otevřete Pull Request a něco ještě není v pořádku, lze to vyjasnit v revizi.

Pokud chcete přispět pouze obsahem a technická cesta se zdá příliš složitá, jednoduše využijte e-mail na stránce Přispět.