Prispievanie k dokumentácii MVVMCross je cenným spôsobom, ako pomôcť zlepšiť rámec a pomôcť ostatným vývojárom. Tu je podrobný sprievodca, ako môžete prispieť:
1. Pochopte štruktúru dokumentácie **
MVVMCross používa Jekyll pre svoju dokumentáciu, čo znamená, že každá stránka vyžaduje prednú hmotu YAML. Zahŕňa to zadanie rozloženia, názvu a kategórie pre stránku. Rozloženie je zvyčajne nastavené na „dokumentáciu“, pokiaľ upravujete blogový príspevok. Kategórie by sa mali znovu použiť a pomenovať v súlade s existujúcimi v ponuke [2].2. Oboznámte sa s Markdownom **
Dokumentácia používa rovnakú syntax Markdown ako GitHub. Na pokyny pre formátovanie môžete odvolať na referenciu Github's Markdown. Zahŕňa to, ako pridať relatívne odkazy a obrázky do vašich stránok dokumentácie [2].3. Nastavenie Jekyll lokálne **
Pre väčšie zmeny je užitočné nastaviť stránky MVVMCross Github lokálne s Jekyll. To vám umožní zobraziť ukážky vašich zmien pred ich odoslaním. Budete musieť nainštalovať Jekyll a postupovať podľa pokynov spoločnosti Github, aby ste nastavili lokálne stránky stránok GitHub [2].4. Pokyny pre príspevky **
- Tituly a vety: Udržujte ich krátke a stručné. Tituly by mali byť v ideálnom prípade dlhé tri alebo štyri slová.- Chronologické poradie: Opíšte témy v logickej sekvencii.
- Zostaňte na téme: Vyhnite sa zablúdeniu od hlavného predmetu.
- Gramatika a interpunkcia: Zabezpečte správne použitie gramatiky a interpunkcie.
- Spelling Deciser: Na minimalizáciu chýb použite kontrolu pravopisu [2].
5. Odošlite svoje príspevky **
Príspevky sa zvyčajne poskytujú prostredníctvom žiadostí o ťahanie GitHub. Môžete upravovať existujúce stránky alebo vytvárať nové. Ak si nie ste istí, ako postupovať, môžete začať navrhnutím zmien alebo ich diskusiou s tímom prostredníctvom problémov GitHub alebo iných podporných kanálov [1] [5].6. Zapojte sa do komunity **
Okrem prispievajúcej dokumentácie môžete tiež pomôcť zdieľaním svojich skúseností s MVVMCross, podaním chýb alebo účasťou na diskusiách. Táto spätná väzba je neoceniteľná na zlepšenie rámca [1].7. Proces kontroly **
Vaše príspevky sa preskúmajú, aby sa zabezpečilo, že sú v súlade so štýlom dokumentácie a normami kvality. Tento proces pomáha udržiavať konzistentnosť v rámci dokumentácie [2].Postupom týchto krokov môžete efektívne prispieť k dokumentácii MVVMCross a pomôcť zlepšiť porozumenie a používanie rámca komunity.
Citácie:[1] https://www.mvvmcross.com/documentation/contributing/contribute
[2] https://www.mvvmcross.com/documentation/contributing/mvvmcross-docs-tyle-guide
[3] https://github.com/mvvmcross/mvvmcross/blob/develop/contributing.md
[4] https://www.mvvmcross.com/documentation/advanced/custoughing-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-verview
[8] https://stackoverflow.com/questions/51552868/mvvmcross-complete-api-api-dacumentation-List/51553028
[9] https://www.mvvmcross.com/documentation/funmamentals/viewmodel-lifecycle
[10] https://github.com/mvvmcross/mvvmcross