At bidrage til MVVMCROSS -dokumentationen er en værdifuld måde at hjælpe med at forbedre rammen og hjælpe andre udviklere. Her er en trin-for-trin-guide til, hvordan du kan bidrage:
1. Forstå dokumentationsstrukturen **
MVVMCROSS bruger Jekyll til sin dokumentation, hvilket betyder, at hver side kræver en YAML -frontmateriale. Dette inkluderer specificering af layout, titel og kategori for siden. Layoutet er typisk indstillet til "dokumentation", medmindre du redigerer et blogindlæg. Kategorier skal genbruges og navngives konsekvent med eksisterende i menuen [2].2. Kend dig til Markdown **
Dokumentationen bruger den samme Markdown -syntaks som GitHub. Du kan henvise til GitHubs Markdown -reference for formateringsretningslinjer. Dette inkluderer, hvordan du tilføjer relative links og billeder til dine dokumentationssider [2].3. Opsætning af Jekyll lokalt **
For større ændringer er det fordelagtigt at oprette MVVMCross GitHub -siderne lokalt med Jekyll. Dette giver dig mulighed for at forhåndsvise dine ændringer, før du indsender dem. Du skal installere Jekyll og følge GitHubs instruktioner til opsætning af et GitHub -sider sted lokalt [2].4. Retningslinjer for bidrag **
- Titler og sætninger: Hold dem korte og kortfattede. Titler skal ideelt set være tre eller fire ord lange.- Kronologisk rækkefølge: Beskriv emner i en logisk sekvens.
- Bliv på emne: Undgå at forvildes fra hovedemnet.
- Grammatik og tegnsætning: Sørg for korrekt brug af grammatik og tegnsætning.
- Stavechecker: Brug en stavekontrol til at minimere fejl [2].
5. Indsend dine bidrag **
Bidrag foretages typisk gennem Github Pull -anmodninger. Du kan redigere eksisterende sider eller oprette nye. Hvis du er usikker på, hvordan du går videre, kan du starte med at foreslå ændringer eller diskutere dem med teamet via GitHub -problemer eller andre supportkanaler [1] [5].6. Engag dig med samfundet **
Udover at bidrage med dokumentation kan du også hjælpe ved at dele dine oplevelser med MVVMCROSS, arkivering af bugs eller deltage i diskussioner. Denne feedback er uvurderlig til forbedring af rammen [1].7. Gennemgangsproces **
Dine bidrag gennemgås for at sikre, at de er i overensstemmelse med dokumentationsstil og kvalitetsstandarder. Denne proces hjælper med at bevare konsistensen på tværs af dokumentationen [2].Ved at følge disse trin kan du effektivt bidrage til MVVMCROSS -dokumentationen og hjælpe med at forbedre samfundets forståelse og brug af rammen.
Citater:[1] https://www.mvvmcross.com/documentation/contributing/contribute
[2] https://www.mvvmcross.com/documentation/contributing/mvvmcross-docs-stil-guide
[3] https://github.com/mvvmcross/mvvmcross/blob/develop/contributing.md
[4] https://www.mvvmcross.com/documentation/advanced/customizing-sising-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