Сприяння документації MVVMcross - це цінний спосіб допомогти покращити рамки та допомогти іншим розробникам. Ось покроковий посібник щодо того, як можна зробити свій внесок:
1. Зрозумійте структуру документації **
MVVMCross використовує Jekyll для своєї документації, а це означає, що кожна сторінка вимагає передньої речовини YAML. Сюди входить уточнення макета, заголовок та категорії для сторінки. Макет, як правило, встановлюється на "документацію", якщо ви не редагуєте публікацію в блозі. Категорії слід повторно використовувати та назвати послідовно з існуючими в меню [2].2. Ознайомтеся з Markdown **
У документації використовується той самий синтаксис відмітки, що і Github. Ви можете посилатися на посилання на відміток Github для форматування керівних принципів. Сюди входить, як додати відносні посилання та зображення до сторінок документації [2].3. Налаштування jekyll локально **
Для великих змін вигідно налаштувати сайт Mvvmcross Github на локально з 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-style-guide
[3] https://github.com/mvvmcross/mvvmcross/blob/devell/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-complete-api-documentation-list/51553028
[9] https://www.mvvmcross.com/documentation/fundamentals/viewmodel-lifecycle
[10] https://github.com/mvvmcross/mvvmcross