Contribuir a la documentación MVVMCross es una forma valiosa de ayudar a mejorar el marco y ayudar a otros desarrolladores. Aquí hay una guía paso a paso sobre cómo puede contribuir:
1. Comprender la estructura de documentación **
MVVMCross usa Jekyll para su documentación, lo que significa que cada página requiere una materia frontal YAML. Esto incluye especificar el diseño, el título y la categoría para la página. El diseño generalmente se establece en "documentación" a menos que esté editando una publicación de blog. Las categorías deben reutilizarse y nombrarse de manera consistente con las existentes en el menú [2].2. Familiarícese con Markdown **
La documentación utiliza la misma sintaxis de Markdown que GitHub. Puede consultar la referencia de Markdown de GitHub para el formateo de pautas. Esto incluye cómo agregar enlaces e imágenes relativas a sus páginas de documentación [2].3. Configuración de Jekyll localmente **
Para cambios más grandes, es beneficioso configurar el sitio de páginas MVVMCross GitHub localmente con Jekyll. Esto le permite obtener una vista previa de sus cambios antes de enviarlos. Deberá instalar Jekyll y seguir las instrucciones de GitHub para configurar un sitio de GitHub Pages localmente [2].4. Pautas de contribución **
- Títulos y oraciones: manténgalos breves y concisos. Idealmente, los títulos deben tener tres o cuatro palabras de largo.- Orden cronológica: describe temas en una secuencia lógica.
- Manténgase en el tema: evite desviarse del tema principal.
- Gramática y puntuación: garantizar el uso adecuado de la gramática y la puntuación.
- Recuperador de ortografía: use un corrector ortográfico para minimizar los errores [2].
5. Envíe sus contribuciones **
Las contribuciones generalmente se realizan a través de solicitudes de extracción de GitHub. Puede editar páginas existentes o crear nuevas. Si no está seguro de cómo proceder, puede comenzar sugiriendo cambios o discutiéndolos con el equipo a través de problemas de GitHub u otros canales de soporte [1] [5].6. Interiértase en la comunidad **
Además de contribuir con la documentación, también puede ayudar compartiendo sus experiencias con MVVMCross, archivando errores o participando en discusiones. Esta retroalimentación es invaluable para mejorar el marco [1].7. Proceso de revisión **
Sus contribuciones serán revisadas para garantizar que se alineen con el estilo de documentación y los estándares de calidad. Este proceso ayuda a mantener la consistencia en toda la documentación [2].Siguiendo estos pasos, puede contribuir de manera efectiva a la documentación MVVMCross y ayudar a mejorar la comprensión y el uso de la comunidad del marco.
Citas:[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/getting-started/mvvmcross-overview
[8] https://stackoverflow.com/questions/51552868/mvvmcross--pomplete-api-documentation-list/51553028
[9] https://www.mvvmcross.com/documentation/fundamentals/viewmodel-lifecycle
[10] https://github.com/mvvmcross/mvvmcross