MVVMCROSS dokumentācijas ieguldījums ir vērtīgs veids, kā palīdzēt uzlabot sistēmu un palīdzēt citiem izstrādātājiem. Šeit ir soli pa solim ceļvedis par to, kā jūs varat dot savu ieguldījumu:
1. Izprotiet dokumentācijas struktūru **
MVVMCROSS savā dokumentācijā izmanto Jekyll, kas nozīmē, ka katrai lapai ir nepieciešama YAML priekšējā lieta. Tas ietver lapas izkārtojuma, nosaukuma un kategorijas norādīšanu. Izkārtojums parasti ir iestatīts uz "dokumentāciju", ja vien jūs nerediģējat emuāra ziņu. Kategorijas jāizmanto atkārtoti un jānosauc konsekventi ar esošajām izvēlnē [2].2. Iepazīstiet sevi ar Markdown **
Dokumentācijā tiek izmantota tāda pati marķējuma sintakse kā Github. Jūs varat atsaukties uz GitHub atskaites atsauci, lai formatētu vadlīnijas. Tas ietver to, kā dokumentācijas lapām pievienot relatīvās saites un attēlus [2].3. Iestatot jekyll lokāli **
Lielāku izmaiņu veikšanai ir izdevīgi iestatīt vietni MVVMCross GitHub lapas vietējā mērogā ar Jekyll. Tas ļauj priekšskatīt izmaiņas pirms to iesniegšanas. Jums būs jāinstalē Jekyll un jāievēro GitHub instrukcijas, kā vietējā mērogā iestatīt GitHub lapu vietni [2].4. Ieguldījumu vadlīnijas **
- Nosaukumi un teikumi: saglabājiet tos īsus un kodolīgus. Nosaukumiem ideālā gadījumā vajadzētu būt trīs vai četriem vārdiem gariem.- Hronoloģiskā secība: aprakstiet tēmas loģiskā secībā.
- Palieciet pie tēmas: izvairieties no galvenā priekšmeta.
- Gramatika un pieturzīmes: nodrošināt pareizu gramatikas un pieturzīmju izmantošanu.
- Pareizrakstības pārbaudītājs: izmantojiet pareizrakstības pārbaudītāju, lai samazinātu kļūdas [2].
5. Iesniedziet savu ieguldījumu **
Iemaksas parasti tiek veiktas, izmantojot GitHub vilkšanas pieprasījumus. Jūs varat rediģēt esošās lapas vai izveidot jaunas. Ja neesat pārliecināts par to, kā rīkoties, varat sākt, ierosinot izmaiņas vai apspriežot tās ar komandu, izmantojot GitHub problēmas vai citus atbalsta kanālus [1] [5].6. iesaistīties sabiedrībā **
Papildus dokumentācijas sniegšanai jūs varat arī palīdzēt, daloties pieredzē ar MVVMCross, iesniedzot kļūdas vai piedaloties diskusijās. Šīs atsauksmes ir nenovērtējamas, lai uzlabotu ietvaru [1].7. Pārskatīšanas process **
Jūsu ieguldījums tiks pārskatīts, lai nodrošinātu, ka tie atbilst dokumentācijas stilam un kvalitātes standartiem. Šis process palīdz saglabāt konsekvenci visā dokumentācijā [2].Veicot šīs darbības, jūs varat efektīvi dot ieguldījumu MVVMCROSS dokumentācijā un palīdzēt uzlabot sabiedrības izpratni un sistēmas izmantošanu.
Atsauces:[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/customing-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-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