Contribuția la documentația MVVMCross este o modalitate valoroasă de a ajuta la îmbunătățirea cadrului și de a ajuta alți dezvoltatori. Iată un ghid pas cu pas despre cum puteți contribui:
1. Înțelegeți structura documentației **
MVVMcross folosește Jekyll pentru documentația sa, ceea ce înseamnă că fiecare pagină necesită o chestiune frontală YAML. Aceasta include specificarea aspectului, titlului și categoriei pentru pagină. Aspectul este de obicei setat pe „documentație”, cu excepția cazului în care editați o postare pe blog. Categoriile ar trebui reutilizate și numite în mod constant cu cele existente din meniu [2].2. Familiarizați -vă cu Markdown **
Documentația folosește aceeași sintaxă Markdown ca GitHub. Vă puteți referi la referința de marcare a Github pentru formatarea orientărilor. Aceasta include modul de adăugare a legăturilor și a imaginilor relative la paginile de documentare [2].3. Configurarea Jekyll la nivel local **
Pentru schimbări mai mari, este benefic să configurați site -ul MVVMCross Github Pagini la nivel local cu Jekyll. Acest lucru vă permite să vă previzualizați modificările înainte de a le trimite. Va trebui să instalați Jekyll și să urmați instrucțiunile Github pentru configurarea unui site GitHub Pagini la nivel local [2].4. Ghiduri de contribuție **
- Titluri și propoziții: păstrați -le scurte și concise. În mod ideal, titlurile ar trebui să aibă trei sau patru cuvinte.- Ordine cronologică: Descrieți subiecte într -o secvență logică.
- Rămâneți pe subiect: Evitați să vă îndepărtați de subiectul principal.
- Gramatică și punctuație: asigurați utilizarea corectă a gramaticii și punctuației.
- Verificator de ortografie: Utilizați un verificator de ortografie pentru a minimiza erorile [2].
5. Trimiteți -vă contribuțiile **
Contribuțiile sunt de obicei aduse prin cererile de tragere Github. Puteți edita paginile existente sau puteți crea altele noi. Dacă nu sunteți sigur despre cum să continuați, puteți începe prin a sugera modificări sau a le discuta cu echipa prin intermediul problemelor GitHub sau a altor canale de asistență [1] [5].6. Implicați -vă cu comunitatea **
Pe lângă documentația care contribuie, vă puteți ajuta, de asemenea, împărtășind experiențele dvs. cu MVVMcross, depunerea de erori sau participarea la discuții. Acest feedback este de neprețuit pentru îmbunătățirea cadrului [1].7. Procesul de revizuire **
Contribuțiile dvs. vor fi revizuite pentru a vă asigura că se aliniază stilului de documentare și standardelor de calitate. Acest proces ajută la menținerea consecvenței între documentație [2].Urmărind acești pași, puteți contribui eficient la documentația MVVMcross și puteți ajuta la îmbunătățirea înțelegerii și utilizării comunității a cadrului.
Citări:[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/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