Přispívající do dokumentace MVVMCross je cenným způsobem, jak pomoci zlepšit rámec a pomoci ostatním vývojářům. Zde je průvodce krok za krokem, jak můžete přispět:
1. Pochopte strukturu dokumentace **
MVVMCross používá pro svou dokumentaci Jekyll, což znamená, že každá stránka vyžaduje přední záležitost YAML. To zahrnuje určení rozvržení, názvu a kategorie pro stránku. Rozložení je obvykle nastaveno na „dokumentaci“, pokud neupravujete blogový příspěvek. Kategorie by měly být znovu použity a pojmenovány v souladu s existujícími v nabídce [2].2.. Seznamte se s Markdown **
Dokumentace používá stejnou syntaxi Markdown jako GitHub. Pokyny pro formátování můžete odkazovat na odkaz GitHubu. To zahrnuje, jak na vaše dokumentační stránky přidat relativní odkazy a obrázky [2].3. nastavení Jekyll Lokálně **
Pro větší změny je užitečné nastavit stránky stránek MVVMCross GitHub lokálně s Jekyll. To vám umožní prohlédnout si změny před jejich odesláním. Budete muset nainstalovat Jekyll a postupovat podle pokynů GitHubu pro lokální nastavení stránek GitHub Pages [2].4. Pokyny pro příspěvek **
- tituly a věty: Udržujte je krátké a stručné. Tituly by měly být v ideálním případě dlouhé tři nebo čtyři slova.- Chronologické pořadí: Popište témata v logické sekvenci.
- Zůstaňte na tématu: Vyvarujte se bloudění z hlavního předmětu.
- Gramatika a interpunkce: Zajistěte správné používání gramatiky a interpunkce.
- kontrola pravopisu: Pomocí kontroly pravopisu minimalizujte chyby [2].
5. Zašlete své příspěvky **
Příspěvky se obvykle provádějí prostřednictvím žádostí o vyžádání GitHub. Můžete upravovat stávající stránky nebo vytvořit nové. Pokud si nejste jisti, jak postupovat, můžete začít tím, že navrhujete změny nebo o nich diskutovat s týmem prostřednictvím problémů GitHub nebo jiných podpůrných kanálů [1] [5].6. Zapojte se do komunity **
Kromě přispívající dokumentace můžete také pomoci sdílením svých zkušeností s MVVMCross, podáním chyb nebo účastí na diskusích. Tato zpětná vazba je neocenitelná pro zlepšení rámce [1].7. Proces review **
Vaše příspěvky budou přezkoumány, aby se zajistilo, že jsou v souladu se stylem dokumentace a standardy kvality. Tento proces pomáhá udržovat konzistenci v celé dokumentaci [2].Dodržováním těchto kroků můžete efektivně přispět k dokumentaci MVVMCross a pomoci zlepšit porozumění a používání rámce komunity.
Citace:[1] https://www.mvvmcross.com/documentation/contributing/contribute
[2] https://www.mvvmcross.com/documentation/contributing/mvvmcross-docs-style-guide
[3] https://github.com/mvvmcross/mvvmcross/blob/develop/contributing.md
[4] https://www.mvvmcross.com/documentation/advanced/customizing-using-app-and-setup
[5] https://www.mvvmcross.com/documentation/
[6] https://github.com/mapsui/mapsui/issues/747
[7] https://www.mvvmcross.com/documentation/getting-started/mvvmcross-overview
[8] https://stackoverflow.com/questions/51552868/mvvmcross-complete-api-documentation-list/51553028
[9] https://www.mvvmcross.com/documentation/fundamentals/viewmodel-lifecycle
[10] https://github.com/mvvmcross/mvvmcross