MVVMCross -dokumentoinnin osallistuminen on arvokas tapa parantaa puitteita ja auttaa muita kehittäjiä. Tässä on vaiheittainen opas siitä, kuinka voit osallistua:
1. Ymmärrä dokumentointirakenne **
MVVMCROSS käyttää Jekylliä dokumentointiinsa, mikä tarkoittaa, että kukin sivu vaatii YAML -etumateriaalia. Tähän sisältyy sivun asettelun, otsikon ja luokan määrittäminen. Asettelu on tyypillisesti asetettu "dokumentaatioon", ellet muokkata blogiviestiä. Luokkia tulisi käyttää uudelleen ja nimetä johdonmukaisesti valikossa olevien olemassa olevien kanssa [2].2. Tutustu Markdowniin **
Dokumentaatio käyttää samaa merkinnän syntaksia kuin GitHub. Voit viitata GitHubin Markdown -viitteeseen muotoiluun. Tämä sisältää kuinka lisätä suhteellisia linkkejä ja kuvia dokumentointisivuihisi [2].3. Jekyllin asettaminen paikallisesti **
Suurempien muutosten saavuttamiseksi on hyödyllistä perustaa MVVMCross Github -sivusto paikallisesti Jekyllin kanssa. Tämän avulla voit esikatsella muutoksia ennen niiden lähettämistä. Sinun on asennettava Jekyll ja noudatettava GitHubin ohjeita GitHub -sivuston asettamiseksi paikallisesti [2].4. Osoitusohjeet **
- Otsikot ja lauseet: Pidä ne lyhyinä ja tiivisinä. Nimikkeiden tulisi mieluiten olla kolme tai neljä sanaa pitkiä.- Kronologinen järjestys: Kuvaile aiheita loogisessa järjestyksessä.
- Pysy aiheessa: Vältä kulkeutumista pääaiheesta.
- Kielioppi ja välimerkit: Varmista kieliopin ja välimerkkien asianmukainen käyttö.
- Oikeinkirjoituksen tarkistus: Käytä oikeinkirjoituksen tarkistajaa virheiden minimoimiseksi [2].
5. Lähetä maksut **
Kasvot tehdään tyypillisesti GitHub -vetopyyntöjen avulla. Voit muokata olemassa olevia sivuja tai luoda uusia. Jos et ole varma siitä, miten edetä, voit aloittaa ehdottamalla muutoksia tai keskustelemalla niistä ryhmän kanssa GitHub -ongelmien tai muiden tukikanavien kautta [1] [5].6. Ota yhteyttä yhteisöön **
Asiakirjojen lisäksi voit myös auttaa jakamalla kokemuksesi MVVMCROSS: n kanssa, arkistointivirheiden kanssa tai osallistumalla keskusteluihin. Tämä palaute on korvaamaton kehyksen parantamiseksi [1].7. Tarkistusprosessi **
Palautussasi tarkistetaan varmistaaksesi, että ne ovat yhdenmukaisia dokumentointityylin ja laatustandardien kanssa. Tämä prosessi auttaa ylläpitämään johdonmukaisuutta dokumentoinnin kautta [2].Näitä vaiheita noudattamalla voit vaikuttaa tehokkaasti MVVMCross -dokumentointiin ja auttaa parantamaan yhteisön ymmärrystä ja kehyksen käyttöä.
Viittaukset:[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/developop/contributing.md
.
[5] https://www.mvvmcross.com/documentation/
[6] https://github.com/mapsui/mapsui/issues/747
.
.
[9] https://www.mvvmcross.com/documentation/fundamentals/viewModel-lifecycle
[10] https://github.com/mvvmcross/mvvmcross