Az MVVMCross dokumentációhoz való hozzájárulás értékes módja annak, hogy javítsák a keretet és segítsék a többi fejlesztőt. Itt van egy lépésről lépésre történő útmutató arról, hogyan lehet hozzájárulni:
1. Megérti a dokumentációs struktúrát **
Az MVVMCross a Jekyll -t használja a dokumentációhoz, ami azt jelenti, hogy minden oldalra YAML elülső anyagot igényel. Ez magában foglalja az oldal elrendezését, címét és kategóriáját. Az elrendezés általában "dokumentációra" van beállítva, hacsak nem szerkeszt egy blogbejegyzést. A kategóriákat újra kell használni, és meg kell nevezni a menüben lévő meglévőkkel következetesen [2].2. Ismerkedjen meg a Markdown -val **
A dokumentáció ugyanazt a Markdown szintaxist használja, mint a GitHub. Hivatkozhat a GitHub Markdown referenciájára a formázási iránymutatásokhoz. Ez magában foglalja a relatív linkek és képek hozzáadásának módját a dokumentációs oldalakhoz [2].3. Jekyll beállítása helyben **
Nagyobb változások esetén hasznos az MVVMCross GitHub oldalak helyének helyben beállítása a Jekyll -rel. Ez lehetővé teszi a változások előnézetét, mielőtt benyújtaná őket. Telepítenie kell a Jekyll -t, és követnie kell a GitHub utasításait a GitHub Pages webhely helyben történő beállításához [2].4. Hozzájárulási iránymutatások **
- Címek és mondatok: tartsa őket röviden és tömören. A címeknek ideális esetben három vagy négy szónak kell lennie.- Időrendszeri sorrend: Írja le a témákat logikai sorrendben.
- Maradjon a témában: Kerülje el a kóborolást a fő témától.
- Nyelvtan és írásjelek: Biztosítsa a nyelvtan és az írásjelek megfelelő használatát.
- helyesírási ellenőrző: Használjon helyesírási ellenőrzőt a hibák minimalizálásához [2].
5. Küldje el a hozzájárulásait **
A hozzájárulásokat általában a GitHub Pull kérésekkel végzik. Szerkesztheti a meglévő oldalakat, vagy újakat hozhat létre. Ha nem biztos benne, hogyan kell folytatni, akkor kezdje meg, ha változtatásokat javasol, vagy megvitatja őket a csapattal a GitHub problémáin vagy más támogatási csatornákon keresztül [1] [5].6. Vegyen részt a közösséggel **
A dokumentáció közreműködése mellett segíthet az MVVMCross -szal való tapasztalatainak megosztása, hibák benyújtása vagy a megbeszélések során való részvétel is. Ez a visszajelzés felbecsülhetetlen értékű a keret javításához [1].7. Áttekintési folyamat **
Az Ön hozzájárulását felülvizsgáljuk annak biztosítása érdekében, hogy megfeleljenek a dokumentációs stílushoz és a minőségi előírásokhoz. Ez a folyamat elősegíti a következetesség fenntartását a dokumentációban [2].Ezeknek a lépéseknek a követésével hatékonyan hozzájárulhat az MVVMCross dokumentációhoz, és elősegítheti a közösség megértésének és használatának javítását.
Idézetek:[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-andsetup
[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