Contribuer à la documentation MVVMCross est un moyen précieux d'aider à améliorer le cadre et d'aider d'autres développeurs. Voici un guide étape par étape sur la façon dont vous pouvez contribuer:
1. Comprendre la structure de documentation **
MVVMCross utilise Jekyll pour sa documentation, ce qui signifie que chaque page nécessite un front YAML. Cela comprend la spécification de la mise en page, du titre et de la catégorie de la page. La mise en page est généralement définie sur la "documentation" à moins que vous modifiiez un article de blog. Les catégories doivent être réutilisées et nommées de manière cohérente avec celles existantes dans le menu [2].2. Familiarisez-vous avec Markdown **
La documentation utilise la même syntaxe Markdown que GitHub. Vous pouvez vous référer à la référence Markdown de GitHub pour la mise en forme des directives. Cela comprend comment ajouter des liens et des images relatifs à vos pages de documentation [2].3. Configuration de Jekyll localement **
Pour des changements plus importants, il est avantageux de configurer localement le site MVVMCross GitHub Pages avec Jekyll. Cela vous permet de prévisualiser vos modifications avant de les soumettre. Vous devrez installer Jekyll et suivre les instructions de GitHub pour configurer localement un site GitHub Pages [2].4. Lignes directrices de contribution **
- Titres et phrases: gardez-les court et concis. Les titres devraient idéalement durer trois ou quatre mots.- Ordre chronologique: décrire des sujets dans une séquence logique.
- Restez sur le sujet: Évitez de vous éloigner du sujet principal.
- Grammaire et ponctuation: assurer une utilisation appropriée de la grammaire et de la ponctuation.
- Vérificateur d'orthographe: utilisez un vérificateur d'orthographe pour minimiser les erreurs [2].
5. Soumettez vos contributions **
Les contributions sont généralement effectuées via des demandes de traction GitHub. Vous pouvez modifier des pages existantes ou en créer de nouvelles. Si vous n'êtes pas sûr de la façon de procéder, vous pouvez commencer par suggérer des modifications ou en discuter avec l'équipe via des problèmes GitHub ou d'autres canaux de support [1] [5].6. Engagez avec la communauté **
En plus de contribuer à la documentation, vous pouvez également vous aider en partageant vos expériences avec MVVMCross, en déposant des bogues ou en participant à des discussions. Cette rétroaction est inestimable pour améliorer le cadre [1].7. Processus de révision **
Vos contributions seront examinées pour s'assurer qu'elles s'alignent sur le style de documentation et les normes de qualité. Ce processus aide à maintenir la cohérence dans la documentation [2].En suivant ces étapes, vous pouvez contribuer efficacement à la documentation MVVMCross et aider à améliorer la compréhension et l'utilisation de la communauté du cadre.
Citations:[1] https://www.mvvmcross.com/Documentation/Contributing/Contribut
[2] https://www.mvvmcross.com/Documentation/Contributing/mvvmcross-docs-tyle-guide
[3] https://github.com/mvvmcross/mvvmcross/blob/develop/contributing.md
[4] https://www.mvvmcross.com/documentation/advanced/custumising-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-complete-api-documentation-list/51553028
[9] https://www.mvvmcross.com/documentation/fundamentals/viewmodel-lifecycle
[10] https://github.com/mvvmcross/mvvmcross