MVVMCROSS -i dokumentatsiooni panus on väärtuslik viis raamistikku parandada ja teisi arendajaid aidata. Siin on samm-sammuline juhend selle kohta, kuidas saate oma panuse anda:
1. Mõista dokumentatsiooni struktuuri **
MVVMCROSS kasutab oma dokumentatsiooni jaoks Jekylli, mis tähendab, et iga leht nõuab YAML -i esiosa. See hõlmab lehe paigutuse, pealkirja ja kategooria täpsustamist. Paigutus on tavaliselt seatud dokumentatsiooniks, kui redigeerite ajaveebi postitust. Kategooriaid tuleks menüüs järjekindlalt nimetada olemasolevatega [2].2.
Dokumentatsioon kasutab sama Markdowni süntaksi nagu GitHub. Suuniste vormindamise jaoks võite viidata GitHubi märgistamise viidele. See hõlmab seda, kuidas lisada oma dokumentatsioonilehtedele suhtelisi linke ja pilte [2].3. Jekylli seadistamine kohapeal **
Suuremate muudatuste jaoks on kasulik seadistada Jekylliga kohapeal MVVMCROSS GitHubi lehtede sait. See võimaldab teil enne nende esitamist oma muudatusi eelvaate teha. Peate installima Jekylli ja järgima GitHubi juhiseid GitHubi lehtede saidi kohapeal seadistamiseks [2].4. Kaastööd **
- pealkirjad ja laused: hoidke neid lühikesi ja lühike. Pealkirjad peaksid ideaalis olema kolm või neli sõna pikad.- Kronoloogiline järjekord: kirjeldage teemasid loogilises järjestuses.
- Jääge teemale: vältige peateemast eemaldumist.
- grammatika ja kirjavahemärgid: tagage grammatika ja kirjavahemärkide nõuetekohane kasutamine.
- õigekirjakontroll: vigade minimeerimiseks kasutage õigekirjakontrolli [2].
5. Esitage oma kaastööd **
Tavaliselt tehakse kaastööd GitHubi tõmbetaotluste kaudu. Saate olemasolevaid lehti redigeerida või uusi luua. Kui te pole kindel, kuidas jätkata, võite alustada muudatuste pakkumisega või nende meeskonnaga arutada GitHubi probleemide või muude tugikanalite kaudu [1] [5].6. suhtle kogukonnaga **
Lisaks dokumentatsioonile saate aidata ka oma kogemusi MVVMCROSS -iga, vigade esitamise või aruteludes osalemisega. See tagasiside on raamistiku parandamiseks hindamatu [1].7. Ülevaateprotsess **
Teie kaastööd vaadatakse üle selleks, et need vastaksid dokumentatsioonistiili ja kvaliteedistandarditele. See protsess aitab säilitada dokumentatsiooni järjepidevust [2].Neid samme järgides saate tõhusalt kaasa aidata MVVMcrossi dokumentatsioonile ja aidata parandada kogukonna mõistmist ja raamistiku kasutamist.
Tsitaadid:[1] https://www.mvvmcross.com/documentation/contributing/contribute
]
[3] https://github.com/mvvmcross/mvvmcross/blob/develop
]
[5] https://www.mvvmcross.com/documentation/
[6] https://github.com/mapsui/mapsui/issues/747
]
]
]
[10] https://github.com/mvvmcross/mvvmcross