IceRock KMM #3 "Устройство проекта" - замечания

Alex009 commented 3 years ago

[x] разбор того, что есть из коробки в mpp-library
[x] что есть в build.gradle и в podfile (чтобы и айосники и андроидщики могли понять всё что есть в проекте) (осталось только про android-app)
[x] разбор что есть и как устроено в android-app
[x] разбор что есть и как устроено в ios-app
[x] описать про генерацию строк локализации через скрипт с гуглшита (нужно проверить достаточно ли того, что есть) (пока нет в бойлерплейте) -> создан раздел в обучении
[x] Из каких частей состоит проект
[x] Где находится конфигурация мультиплатформенного модуля
[x] Как реализована интеграция мультиплатформенного модуля в iOS
[x] Какие настройки применены к текущему проекту для мультиплатформенного модуля ( про конфигурации в build gradle kts)
[x] Как устроена многомодульность на проекте
[x] Как объявляются внешние зависимости (библиотеки)
[x] Как настроен экспорт зависимостей в iOS фреймворк
[x] Как реализован DI (Dependency Injection)
[x] Как реализована навигация на android и iOS (про iOS написано) (переехало в раздел обучения)
[x] Студия предложила обновить Android Gradle Plugin, какие плагины и зависимости можно обновлять без последствий? (обновлять можно все в принципе, но на мажорных апдейтах (типа AGP 7 или kotlin 1.5.0) есть высокая вероятность что что-то будет несовместимо, поэтому такие апдейты надо делать аккуратно и проверяя что будет с обеими платформами.) -> создан соответствующий раздел в обучении
[x] В бойлерплейт podfile нужно добавить маппинг конфигураций
[x] в podfile описать маппинг конфигураций, что это и зачем (ссылка на статью Learning - iOS - Конфигурации)
[x] в podspec настроить для симулятора компиляцию arm через дополнительные условия -> изменено в рамках boilerplate проекта
[x] Создадим в ios-проекте папку src/Coordinators исправить на src -> Common -> Coordinator "и создавать нечего не нужно , ведь там уже описание есть"
[x] Не хватает документирования методов и кода для лучшего восприятия //MARK: и ему подобные. (FelixFalkovsky) (?) (добавлены комментарии в коде)
[x] Отредактировать статью в местах где говориться что то сделать "Уже сделано!" либо удалить из проекта эти файлы. (FelixFalkovsky) (?)
[x] в Навигация в iOS добавить изображения для лучшего понимания
[x] предложение: заменить некоторые скриншоты на полные, вместо какой-то области, для наглядности
[x] нужно добавить в Deps.kt -> Modules еще варианты, например Entities, Shared ( устарело)
[x] Добавить что buildSrc больше не используется, ему на смену пришел Versions Catalog

Добавленные статьи в разделе обучения: Library -> Публикация Gradle -> Обвноление версий Gradle -> Build Environment iOS -> CocoaPods iOS -> Навигация Tools -> Генерация строк локализациии

https://kmm.icerock.dev/onboarding/project-inside

Alex009 commented 3 years ago

от @FelixFalkovsky

Построение навигации в iOS приложении Было бы не плохо добавить изображения как примеры.

Создадим в ios-проекте папку src/Coordinators исправить на src -> Common -> Coordinator "и создавать нечего не нужно , ведь там уже описание есть"

Не хватает документирования методов и кода для лучшего восприятия //MARK: и ему подобные.

Отредактировать статью в местах где говориться что то сделать "Уже сделано!" либо удалить из проекта эти файлы.

Заменить часть скриншотов и лучше бы если бы они были полными а не кусками , восприятие другое.

Alex009 commented 3 years ago

вместо codelab будет сделана статья на kmm.icerock.dev - https://kmm.icerock.dev/onboarding/project-inside