Der Beitrag zur MVVMCross -Dokumentation ist eine wertvolle Möglichkeit, den Rahmen zu verbessern und anderen Entwicklern zu unterstützen. Hier finden Sie eine Schritt-für-Schritt-Anleitung, wie Sie dazu beitragen können:
1. Verstehen Sie die Dokumentationsstruktur **
MVVMCross verwendet Jekyll für seine Dokumentation, was bedeutet, dass für jede Seite eine Yaml -Frontmaterie erforderlich ist. Dies beinhaltet das Layout, den Titel und die Kategorie für die Seite. Das Layout wird normalerweise auf "Dokumentation" eingestellt, es sei denn, Sie bearbeiten einen Blog -Beitrag. Kategorien sollten wiederverwendet und konsequent mit vorhandenen im Menü [2] benannt werden.2. Machen Sie sich mit Markdown ** vertraut gemacht
Die Dokumentation verwendet die gleiche Markdown -Syntax wie GitHub. Sie können sich auf die Markdown -Referenz von Github finden Sie für Formatierungsrichtlinien. Dies beinhaltet, wie Sie Ihren Dokumentationsseiten relative Links und Bilder hinzufügen [2].3. Einrichten von Jekyll Lokal **
Bei größeren Änderungen ist es vorteilhaft, die MVVMCross -Github -Seiten lokal mit Jekyll einzurichten. Auf diese Weise können Sie Ihre Änderungen vorantreiben, bevor Sie sie senden. Sie müssen Jekyll installieren und die Anweisungen von Github befolgen, um eine Github -Seiten lokal einzurichten [2].4. Beitragsrichtlinien **
- Titel und Sätze: Halten Sie sie kurz und präzise. Titel sollten idealerweise drei oder vier Wörter lang sein.- Chronologische Ordnung: Beschreiben Sie Themen in einer logischen Reihenfolge.
- Bleiben Sie beim Thema: Vermeiden Sie das Streunieren des Hauptthemens.
- Grammatik und Interpunktion: Stellen Sie die ordnungsgemäße Verwendung von Grammatik und Interpunktion sicher.
- Rechtschreibprüfung: Verwenden Sie einen Rechtschreibprüfung, um Fehler zu minimieren [2].
5. Senden Sie Ihre Beiträge **
Beiträge werden in der Regel durch Github Pull -Anfragen geleistet. Sie können vorhandene Seiten bearbeiten oder neue erstellen. Wenn Sie sich nicht sicher sind, wie Sie vorgehen sollen, können Sie zunächst Änderungen vorschlagen oder sie über Github -Probleme oder andere Support -Kanäle mit dem Team besprechen [1] [5].6. In Zusammenarbeit mit der Community **
Neben der Beitragsdokumentation können Sie auch helfen, indem Sie Ihre Erfahrungen mit MVVMCross, Einreichung von Fehler oder Teilnahme an Diskussionen teilen. Dieses Feedback ist von unschätzbarem Wert für die Verbesserung des Rahmens [1].7. Überprüfungsprozess **
Ihre Beiträge werden überprüft, um sicherzustellen, dass sie den Dokumentationsstil und den Qualitätsstandards übereinstimmen. Dieser Prozess hilft bei der Aufrechterhaltung der Konsistenz in der Dokumentation [2].Wenn Sie diese Schritte befolgen, können Sie effektiv zur MVVMCross -Dokumentation beitragen und dazu beitragen, das Verständnis und die Verwendung des Frameworks der Community zu verbessern.
Zitate:[1] https://www.mvvmcross.com/documentation/contributing/contribute
[2] https://www.mvvmcross.com/documentation/contributing/mvmcross-docs-style-guide
[3] https://github.com/mvvmcross/mvmcross/blob/develop/contributing.md
[4] https://www.mvvmcross.com/documentation/advanced/customizing-using-app-setup
[5] https://www.mvmcross.com/documentation/
[6] https://github.com/mapsui/mapsui/issues/747
[7] https://www.mvmcross.com/documentation/getting-started/mvmcross-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