Вклад в документацию MVVMcross является ценным способом помочь улучшить структуру и помочь другим разработчикам. Вот пошаговое руководство о том, как вы можете внести свой вклад:
1. Понять структуру документации **
MVVMcross использует Jekyll для его документации, что означает, что каждая страница требует передней материи YAML. Это включает в себя указание макета, заголовка и категории для страницы. Макет обычно устанавливается для «документации», если вы не редактируете сообщение в блоге. Категории должны быть повторно использованы и названы последовательно с существующими в меню [2].2. Познакомьтесь с Marckdown **
В документации используется тот же синтаксис отметки, что и GitHub. Вы можете ссылаться на ссылку на отметки Github для форматирования рекомендаций. Это включает в себя, как добавить относительные ссылки и изображения на страницы документации [2].3. Настройка Jekyll локально **
Для больших изменений полезно настроить сайт GitHub MvvMcross на местном уровне с Jekyll. Это позволяет вам предварительно просмотреть ваши изменения, прежде чем отправлять их. Вам нужно будет установить Jekyll и следовать инструкциям GitHub для настройки сайта GitHub Pages локально [2].4. Руководство по вкладу **
- Названия и предложения: Держите их короткими и лаконичными. Названия в идеале должны быть три или четыре слова длиной.- Хронологический порядок: опишите темы в логической последовательности.
- Оставайтесь на теме: избегайте отклонения от основного предмета.
- Грамматика и пунктуация: обеспечить правильное использование грамматики и пунктуации.
- Проверка орфографии: используйте проверку орфографии, чтобы минимизировать ошибки [2].
5. отправьте свои взносы **
Взносы обычно вносятся через запросы на притяжение GitHub. Вы можете редактировать существующие страницы или создать новые. Если вы не уверены в том, как продолжить, вы можете начать с предложения об изменениях или обсудить их с командой с помощью проблем GitHub или других каналов поддержки [1] [5].6. Включитесь с сообществом **
Помимо внесения документации, вы также можете помочь, поделившись своим опытом с MVVMcross, подачи ошибок или участия в обсуждениях. Эта обратная связь бесценна для улучшения структуры [1].7. Процесс обзора **
Ваш вклад будет рассмотрен, чтобы убедиться, что они соответствуют стилю документации и стандартам качества. Этот процесс помогает поддерживать последовательность в документации [2].Следуя этим этапам, вы можете эффективно внести свой вклад в документацию MVVMcross и помочь улучшить понимание и использование сообщества.
Цитаты:[1] https://www.mvvmcross.com/documentation/contributing/contribute
[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/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-completemy-api-documentation-list/51553028
[9] https://www.mvvmcross.com/documentation/fundamentals/viewmodel-lifecycle
[10] https://github.com/mvvmcross/mvvmcross