Wkład w dokumentację MVVMCROSS jest cennym sposobem na ulepszenie ram i pomoc innym programistom. Oto przewodnik krok po kroku, w jaki sposób możesz wnieść:
1. Zrozum strukturę dokumentacji **
MVVMCROSS używa Jekyll do swojej dokumentacji, co oznacza, że każda strona wymaga przedniej materii YAML. Obejmuje to określenie układu, tytułu i kategorii strony. Układ jest zazwyczaj ustawiony na „dokumentację”, chyba że edytujesz post na blogu. Kategorie powinny być ponownie wykorzystywane i konsekwentnie nazwane z istniejącymi w menu [2].2. Zapoznaj się z Markdown **
Dokumentacja wykorzystuje tę samą składnię Markdown co GitHub. Możesz odwołać się do odniesienia Github na wytyczne dotyczące formatowania. Obejmuje to, jak dodać względne linki i obrazy do stron dokumentacji [2].3. Konfigurowanie Jekyll lokalnie **
W przypadku większych zmian korzystne jest skonfigurowanie strony MVVMCROS GITHUB na lokalnie za pomocą Jekyll. To pozwala podglądać zmiany przed ich przesłaniem. Musisz zainstalować Jekyll i postępować zgodnie z instrukcjami GitHub dotyczącymi lokalnego konfigurowania strony Github Pages [2].4. Wytyczne dotyczące wkładu **
- Tytuły i zdania: Zachowaj je krótkie i zwięzłe. Tytuły powinny mieć idealnie trzy lub cztery słowa.- Porządek chronologiczny: Opisz tematy w logicznej sekwencji.
- Pozostań na temat: Unikaj błąkania się z głównego tematu.
- Gramatyka i interpunkcja: Zapewnij właściwe użycie gramatyki i interpunkcji.
- Sprawdzanie pisowni: Użyj sprawdzania pisowni, aby zminimalizować błędy [2].
5. Prześlij swoje wkład **
Wkłady są zazwyczaj wkładane za pośrednictwem żądań github. Możesz edytować istniejące strony lub tworzyć nowe. Jeśli nie masz pewności, jak kontynuować, możesz zacząć od zasugerowania zmian lub omówienia ich z zespołem za pośrednictwem problemów GitHub lub innymi kanałami wsparcia [1] [5].6. Zaangażuj się ze społecznością **
Oprócz dokumentacji, możesz również pomóc, dzieląc się swoimi doświadczeniami z MVVMCROSS, składając błędy lub uczestniczenie w dyskusjach. Ta informacja zwrotna jest nieoceniona w celu poprawy ramy [1].7. Proces recenzji **
Twoje wkład zostaną sprawdzone, aby zapewnić one zgodność z stylem dokumentacji i standardami jakości. Proces ten pomaga utrzymać spójność w ramach dokumentacji [2].Postępując zgodnie z tymi krokami, możesz skutecznie przyczynić się do dokumentacji MVVMCROSS i pomóc zwiększyć zrozumienie i wykorzystanie ram przez społeczność.
Cytaty:[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-andetup
[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