Prispevek k dokumentaciji MVVMcross je dragocen način za izboljšanje okvira in pomoč drugim razvijalcem. Tu je vodnik po korakih o tem, kako lahko prispevate:
1. Razumevanje strukture dokumentacije **
MVVMcross uporablja Jekyll za svojo dokumentacijo, kar pomeni, da vsaka stran zahteva sprednjo zadevo YAML. To vključuje določitev postavitve, naslova in kategorije za stran. Postavitev je običajno nastavljena na "Dokumentacija", razen če urejate objavo na spletnem dnevniku. Kategorije je treba v meniju ponovno uporabiti in imenovati dosledno z obstoječimi [2].2. Seznanite se z Markdownom **
Dokumentacija uporablja isto sintakso Markdown kot GitHub. Za oblikovanje smernic se lahko sklicujete na GitHub -ovo referenco. To vključuje, kako dodati relativne povezave in slike na strani dokumentacije [2].3. Nastavitev jekyll lokalno **
Za večje spremembe je koristno, da na lokalni strani MVVMcross GitHub nastavite lokalno z Jekyllom. To vam omogoča, da si ogledate spremembe, preden jih predložite. Morali boste namestiti Jekyll in slediti navodilom GitHub za nastavitev lokalnega mesta GitHub Pages [2].4. Smernice za prispevek **
- Naslovi in stavki: Naj bodo kratki in jedrnati. Naslovi bi morali biti v idealnem primeru dolgi tri ali štiri besede.- Kronološki vrstni red: Opišite teme v logičnem zaporedju.
- Ostanite na temi: Izogibajte se oddaljevanju od glavne teme.
- Slovnica in ločila: Zagotovite pravilno uporabo slovnice in ločil.
- Črkovanje preverjanja: Za čiščenje napak uporabite črkovanje črkovanja [2].
5. Predložite svoje prispevke **
Prispevki se običajno dajejo s pomočjo GitHub zahtevkov. Lahko urejate obstoječe strani ali ustvarite nove. Če niste prepričani, kako nadaljevati, lahko začnete tako, da predlagate spremembe ali jih razpravljate z ekipo prek težav z GitHub ali drugimi podpornimi kanali [1] [5].###. Sodelujte s skupnostjo **
Poleg prispevanja dokumentacije lahko pomagate tudi tako, da svoje izkušnje delite z MVVMcross, vložite napake ali sodelujete v razpravah. Ta povratna informacija je neprecenljiva za izboljšanje okvira [1].
7. Postopek pregleda **
Vaši prispevki bodo pregledani, da se zagotovi, da se uskladijo s slog dokumentacije in standardi kakovosti. Ta postopek pomaga ohranjati doslednost v dokumentaciji [2].Če sledite tem korakom, lahko učinkovito prispevate k dokumentaciji MVVMcross in pomagate izboljšati razumevanje in uporabo okvira skupnosti.
Navedbe:[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/isissue/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