Dokumentace architektur je uložena v tomto repositáři, tedy přispívání probíhá skrze Pull Requests.
Pokud nevíte, jak přispívat na GitHubu, tak můžete navštívit stránku s příručkou pro nové přispěvatele.
Tato sekce se zabývá položkou Issues v rámci tohoto GitHub repositáře.
Pokud narazíte na problém s dokumentací libovolné architektury, tak nejdříve vyhledejte, jestli někdo neotevřel stejný problém. Pokud nikdo problém neotevřel, tak lze skrze formulář pro Issues otevřít nový problém.
V rámci tohoto repositáře se nikomu nepřiřazují problémy, ale pokud máte řešení nějakého konkrétního problémů, tak otevřte PR spojené s daným problémem.
Provádění změn lze provádět skrze webový prohlížeč, kdy lze editovat stránky dokumentace přímo. Dále lze provádět změny lokálně na vlastní větvy (nebo forku repositáře), a pak vytvářet Pull Request se změnami.
- Nainstalovat Git
- Fork repositáře
- Pomocí GitHub Desktop
- Pomocí příkazového řádku (CLI)
- Pomocí GitHub CodeSpaces
- Provedení změn v repositáři
- Commit změn
- Vytvoření PR
TODO: přidat sekci o GitHub pages
Poté co jste provedli změny v repositáři, tak je třeba provést tzv. stage změn (příkaz git add), a pak je třeba provést commit změn s následným push commitu s vhodnou zprávou.
PR můžete otevírat skrze GitHub.com, GitHub Desktop, CLI a jiné.
Pokud budete mít problémy s konflikty, tak se můžete podívat na git tutoriál, který vám s tím může pomoct.
Změny do dokumentace potvrzuje architekt nebo osoba, jež má na starost dokumentaci architektury.