Å bidra til MVVMCROSS -dokumentasjonen er en verdifull måte å bidra til å forbedre rammene og hjelpe andre utviklere. Her er en trinn-for-trinns guide om hvordan du kan bidra:
1. Forstå dokumentasjonsstrukturen **
MVVMCROSS bruker Jekyll for sin dokumentasjon, noe som betyr at hver side krever en YAML -frontsaker. Dette inkluderer å spesifisere oppsett, tittel og kategori for siden. Oppsettet er vanligvis satt til "dokumentasjon" med mindre du redigerer et blogginnlegg. Kategorier bør brukes på nytt og navngitt konsekvent med eksisterende i menyen [2].2. Vend deg med Markdown **
Dokumentasjonen bruker samme markdown -syntaks som GitHub. Du kan henvise til GitHubs Markdown -referanse for formateringsretningslinjer. Dette inkluderer hvordan du legger til relative lenker og bilder på dokumentasjonssidene [2].3. Sette opp Jekyll lokalt **
For større endringer er det gunstig å sette opp MVVMCROSS GitHub -sidene lokalt med Jekyll. Dette lar deg forhåndsvise endringene dine før du sender dem inn. Du må installere Jekyll og følge GitHubs instruksjoner for å sette opp et GitHub -sider -nettsted lokalt [2].4. Bidragsretningslinjer **
- Titler og setninger: Hold dem korte og konsise. Titler bør ideelt sett være tre eller fire ord lange.- Kronologisk rekkefølge: Beskriv emner i en logisk sekvens.
- Hold deg på emnet: Unngå å streite fra hovedemnet.
- Grammatikk og tegnsetting: Sikre riktig bruk av grammatikk og tegnsetting.
- Stavekontroll: Bruk en stavekontroll for å minimere feil [2].
5. Send inn bidragene dine **
Bidrag blir vanligvis gitt gjennom forespørsler om GitHub Pull. Du kan redigere eksisterende sider eller opprette nye. Hvis du er usikker på hvordan du går frem, kan du starte med å foreslå endringer eller diskutere dem med teamet via GitHub -problemer eller andre støttekanaler [1] [5].6. engasjere seg med samfunnet **
I tillegg til å bidra med dokumentasjon, kan du også hjelpe ved å dele dine erfaringer med MVVMCROSS, arkivere feil eller delta i diskusjoner. Denne tilbakemeldingen er uvurderlig for å forbedre rammen [1].7. Gjennomgangsprosess **
Dine bidrag vil bli gjennomgått for å sikre at de stemmer overens med dokumentasjonsstilen og kvalitetsstandardene. Denne prosessen hjelper til med å opprettholde konsistens på tvers av dokumentasjonen [2].Ved å følge disse trinnene, kan du effektivt bidra til MVVMCROSS -dokumentasjonen og bidra til å forbedre samfunnets forståelse og bruk av rammen.
Sitasjoner:[1] https://www.mvvmcross.com/documentation/contributing/contribrible
[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-apps-av-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