Bijdragen aan de MVVMCross -documentatie is een waardevolle manier om het framework te helpen verbeteren en andere ontwikkelaars te helpen. Hier is een stapsgewijze handleiding over hoe u kunt bijdragen:
1. Begrijp de documentatiestructuur **
MVVMCross gebruikt Jekyll voor zijn documentatie, wat betekent dat elke pagina een YAML -voorkant vereist. Dit omvat het opgeven van de lay -out, titel en categorie voor de pagina. De lay -out is meestal ingesteld op "documentatie", tenzij u een blogbericht bewerkt. Categorieën moeten worden hergebruikt en consistent worden genoemd met bestaande in het menu [2].2. Maak uzelf vertrouwd met Markdown **
De documentatie gebruikt dezelfde Markdown -syntaxis als GitHub. U kunt verwijzen naar GitHub's Markdown -referentie voor het opmaken van richtlijnen. Dit omvat het toevoegen van relatieve links en afbeeldingen aan uw documentatiepagina's [2].3. Jekyll lokaal opzetten **
Voor grotere veranderingen is het nuttig om de MVVMCross Github -pagina's locaal in te stellen met Jekyll. Hiermee kunt u een voorbeeld van uw wijzigingen bekijken voordat u ze indient. U moet Jekyll installeren en de instructies van GitHub volgen voor het lokaal instellen van een GitHub Pagina's -site [2].4. Bijdrage richtlijnen **
- Titels en zinnen: houd ze kort en beknopt. Titels moeten idealiter drie of vier woorden lang zijn.- Chronologische volgorde: beschrijf onderwerpen in een logische volgorde.
- Blijf op het onderwerp: Vermijd niet af te wijken van het hoofdonderwerp.
- Grammatica en interpunctie: zorg voor een goed gebruik van grammatica en interpunctie.
- Springscontrole: gebruik een spellingscontrole om fouten te minimaliseren [2].
5. uw bijdragen indienen **
Bijdragen worden meestal gedaan via GitHub -pull -aanvragen. U kunt bestaande pagina's bewerken of nieuwe maken. Als u niet zeker weet hoe u verder moet gaan, kunt u beginnen met het suggereren van wijzigingen of het bespreken van deze met het team via GitHub -problemen of andere ondersteuningskanalen [1] [5].6. Betrokken met de gemeenschap **
Naast het bijdragen van documentatie, kunt u ook helpen door uw ervaringen te delen met MVVMCross, bugs in te dienen of deel te nemen aan discussies. Deze feedback is van onschatbare waarde voor het verbeteren van het raamwerk [1].7. Reviewproces **
Uw bijdragen worden beoordeeld om ervoor te zorgen dat ze aansluiten bij de documentatiestijl en kwaliteitsnormen. Dit proces helpt de consistentie in de documentatie te behouden [2].Door deze stappen te volgen, kunt u effectief bijdragen aan de MVVMCross -documentatie en het begrip en het gebruik van het kader van de gemeenschap helpen verbeteren.
Citaten:[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