Att bidra till MVVMCross -dokumentationen är ett värdefullt sätt att förbättra ramverket och hjälpa andra utvecklare. Här är en steg-för-steg-guide om hur du kan bidra:
1. Förstå dokumentationsstrukturen **
MVVMCROSS använder Jekyll för sin dokumentation, vilket innebär att varje sida kräver en YAML Front Matter. Detta inkluderar att specificera layout, titel och kategori för sidan. Layouten är vanligtvis inställd på "dokumentation" såvida du inte redigerar ett blogginlägg. Kategorier bör återanvändas och namnges konsekvent med befintliga i menyn [2].2. Bekanta dig med Markdown **
Dokumentationen använder samma Markdown -syntax som GitHub. Du kan hänvisa till GitHubs Markdown -referens för formateringsriktlinjer. Detta inkluderar hur du lägger till relativa länkar och bilder på dina dokumentationssidor [2].3. Ställa in Jekyll lokalt **
För större förändringar är det fördelaktigt att ställa in webbplatsen MVVMCross GitHub -sidor lokalt med Jekyll. Detta gör att du kan förhandsgranska dina ändringar innan du skickar in dem. Du måste installera Jekyll och följa GitHubs instruktioner för att ställa in en github -sidplats lokalt [2].4. Riktlinjer för bidrag **
- Titlar och meningar: Håll dem korta och kortfattade. Titlar bör helst vara tre eller fyra ord långa.- Kronologisk ordning: Beskriv ämnen i en logisk sekvens.
- Håll dig i ämnet: Undvik att tappa från huvudämnet.
- Grammatik och skiljetecken: Säkerställa korrekt användning av grammatik och skiljetecken.
- Stavningskontroll: Använd en stavningskontroll för att minimera fel [2].
5. Skicka dina bidrag **
Bidrag görs vanligtvis genom GitHub Pull -förfrågningar. Du kan redigera befintliga sidor eller skapa nya. Om du är osäker på hur du ska gå vidare kan du börja med att föreslå förändringar eller diskutera dem med teamet via Github -problem eller andra supportkanaler [1] [5].6. Engagera med samhället **
Förutom att bidra med dokumentation kan du också hjälpa till genom att dela dina erfarenheter med MVVMCross, arkivera buggar eller delta i diskussioner. Denna feedback är ovärderlig för att förbättra ramverket [1].7. Granskningsprocess **
Dina bidrag kommer att granskas för att säkerställa att de anpassar sig till dokumentationsstilen och kvalitetsstandarderna. Denna process hjälper till att upprätthålla konsistens över dokumentationen [2].Genom att följa dessa steg kan du effektivt bidra till MVVMCross -dokumentationen och hjälpa till att förbättra samhällets förståelse och användning av ramverket.
Citeringar:[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/geting-started/mvvmcross-overview
[8] https://stackoverflow.com/questions/51552868/mvvmcross-complete-api-documentations-list/51553028
[9] https://www.mvvmcross.com/documentation/fundamentals/viewmodel-lifecycle
[10] https://github.com/mvvmcross/mvvmcross