Prisidėjimas prie „MVVMCross“ dokumentacijos yra vertingas būdas padėti patobulinti sistemą ir padėti kitiems kūrėjams. Čia yra žingsnis po žingsnio vadovas, kaip galite prisidėti:
1. Supraskite dokumentų struktūrą **
„MVVMCross“ savo dokumentacijai naudoja „Jekyll“, tai reiškia, kad kiekvienam puslapiui reikalingas „Yaml“ priekinė medžiaga. Tai apima puslapio išdėstymo, pavadinimo ir kategorijos nurodymą. Paprastai išdėstymas yra nustatytas kaip „dokumentacija“, nebent redaguojate tinklaraščio įrašą. Kategorijos turėtų būti pakartotinai naudojamos ir nuosekliai pavadintos esamomis meniu [2].2. Susipažinkite su Markdown **
Dokumentacijoje naudojama ta pati žymėjimo sintaksė kaip „GitHub“. Galite kreiptis į „GitHub“ ženklo nuorodą, kaip nurodyti formatavimo gaires. Tai apima, kaip pridėti santykines nuorodas ir vaizdus į savo dokumentacijos puslapius [2].3. „Jekyll“ nustatymas vietoje **
Didesniems pakeitimams naudinga nustatyti „MVVMCross GitHub“ puslapių svetainę vietoje su „Jekyll“. Tai leidžia peržiūrėti pakeitimus prieš juos pateikiant. Turėsite įdiegti „Jekyll“ ir vykdyti „GitHub“ instrukcijas, kaip nustatyti „GitHub“ puslapių svetainę vietoje [2].4. Įmokos gairės **
- Pavadinimai ir sakiniai: Laikykite juos trumpus ir glaustus. Idealiu atveju pavadinimai turėtų būti trijų ar keturių žodžių ilgio.- Chronologinė tvarka: Apibūdinkite loginės sekos temas.
- Likite tema: venkite paslėpti pagrindinę temą.
- Gramatika ir skyrybos ženklai: Užtikrinkite tinkamą gramatikos naudojimą ir skyrybos ženklus.
- rašybos tikrintuvas: Norėdami sumažinti klaidas, naudokite rašybos tikrintuvą [2].
5. Pateikite savo įmokas **
Įmokos paprastai atliekamos naudojant „GitHub Pull“ užklausas. Galite redaguoti esamus puslapius arba sukurti naujus. Jei nesate tikri, kaip elgtis toliau, galite pradėti pasiūlyti pakeitimus arba aptarti juos su komanda naudodamiesi „GitHub“ klausimais ar kitais palaikymo kanalais [1] [5].6. Bendrauti su bendruomene **
Be to, kad prisidedate prie dokumentacijos, taip pat galite padėti pasidalydami savo patirtimi su MVVMCross, pateikdami klaidas ar dalyvaudami diskusijose. Šis atsiliepimas yra neįkainojamas norint pagerinti sistemą [1].7. Peržiūros procesas **
Jūsų indėlis bus peržiūrėtas siekiant užtikrinti, kad jie atitiktų dokumentacijos stilių ir kokybės standartus. Šis procesas padeda išlaikyti nuoseklumą visuose dokumentuose [2].Atlikdami šiuos veiksmus, galite veiksmingai prisidėti prie MVVMCross dokumentacijos ir padėti sustiprinti bendruomenės supratimą ir naudojimą.
Citatos:[1] https://www.mvvmcross.com/documentation/contributining/contribute
[2] https://www.mvvmcross.com/documentation/contributing/mvvmcross-docs-style-guide
[3] https://github.com/mvvmcross/mvvmcross/blob/develop/contributisting.md
[4] https://www.mvvmcross.com/documentation/advanced/customizing-using-app ir-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