Проектирование библиотек. НАЧАЛО

Знаете, что такое «двойное дно»? Это когда вы открываете коробку, находите в ней массу вещей, затем поднимаете дно и находите что-то еще. А представляете каким может быть «тройное дно»? Или «четверное»? Как много можно вытащить из одной коробки? Как много можно заложить в один фреймворк?

Сегодня мы поговорим о том как спроектировать свою библиотеку и не оказаться стариком преисполненным сожалений, одиноко ждущим звездочки на гитхабе

Transcript

1. Александр Блинов 24/11/2017 a.blinov@redmadrobot.com #DROIDCON #REDMADROBOT НАЧАЛО проектирование библиотек
2. Александр Блинов a.blinov@redmadrobot.com Руководитель группы Android разработки Участник подкастов Админ чата по архитектуре Android Соавтор Moxy Выступаю на конференциях
3. О чем будем говорить О бщ ие понятия Сообщ ество П роектирование Д истрибуция С чего начать Слож ности П ланирование
4. Введение
5. Рецепт написания библиотеки Неееееееет!!!1 2. Залить его на github/bitbucket /еще куда-то 3. 1. Вынести общий код
6. Библиотека vs Фреймворк
7. Internal Open source Доступ Команда Сообщество Bug report Команда Сообщество Bug fix Команда Сообщество Статьи и доклады NDA ;) Opensource?
8. Уровень 1 Планирование
9. Установить цель - 1000 звезд на гитхабе - Не писать больше авторизацию - Утвердить в команде фреймворк для который победит жизненный цикл
10. Планирование ОТСЕЧЬ СРОК - Месяц - Квартал Сейчас Конец квартала
11. Планирование КРИВАЯ ГАРТНЕРА
12. Сформировать видение Сейчас Конец квартала Я из будущего - Магия (из Moxy) - Документация - Тесты Хотелки
13. Сформировать видение ПРИЁМЫ - Как хотелось бы в идеале - Я не понимаю как что-то сделать / Я не понимаю что я не понимаю - Синхронизироваться с кем-либо - Top to bottom - Открытые вопросы
14. Research - Актуальность • SoF • Чаты • На сколько нужно самому - Аналоги - Осуществимость
15. Реверсивное планирование Сейчас Конец квартала Конец квартала П одготовить doc Вы лож ить в m aven
16. - Не углубляться в детали - Выявить ограничения (событийные) Реверсивное планирование РЕКОМЕНДАЦИИ
17. Ресурсы х
18. Ресурсы х
19. Ресурсы КАЛЕНДАРЬ
20. - Пересмотреть видение - Понять стоит ли ввязываться - Положить план на календарь Итоги планирования
21. - Фичелист - Оценка - Backlog План работ
22. Часть 2 Реализация
23. Проектирование - Single Responsibility (для всей библиотеки) - Top to bottom - SOLID
24. API - Баланс между кастомизацией и удобством - Лаконичность - Недвусмысленность - Сокрытие реализации - Обратная совместимость / миграция
25. Решение из коробки - Ожидаемое поведение (Стратегии в Moxy) - Настройки по умолчанию (Reflection в Toothpick)
26. Сторонние библиотеки - Ограниченное использование - Compile Only - Включение Rx как дополнительной опции
27. Тесты Тесты Тесты Тесты Тесты Тесты Тесты Тесты Тесты Тесты Тесты Тесты
28. Уровень 3 Комьюнити
29. Продвижение - Конференции - Статьи - Чаты
30. Поддержка - Обработка Issue на Github & SoF - Ответы на вопросе в чате и личные сообщения - Развитие библиотеки
31. Уровень 4 Дистрибуция
32. Типы лицензий
33. Публикация
34. README - Image, screenshot or/and animation - Tags - Description - Installation - Usage - Authors - Roadmap - Contributing guidelines
35. Чек лист - Заливка дистрибутива в Maven/Bintray - README + Wiki - Документация в исходном коде - Open Source License - Удалена предыдущая история commit’ов - Commit'ы на английском.
36. Уровень 5 Подводные камни
37. Проблем при разработке - Текучка (решение: Приоритезация) - Не понятно как это делать и с чего начать (решение: Декомпозиция) - Пропадает энтузиазм (решение: План)
38. Работа - Отсутствие :) - Pull requests - Feature requests Проблемы с сообществом
39. Trade-off 58 НЕНАПРЯЖНО САМО СОБОЙ Сложно - Качество - Скорость - Моральные силы
40. Частые ошибки - Постепенно идти не зная куда - Закапывание в детали
41. Уровень 6 С чего начать?
42. С чего начать? - Смотреть на внутреннее устройство библиотек - Контрибьютить в opensource - Разработать внутренние библиотеки - Написать мааааленькую open source библиотеку
43. Сontributing to open source ВЫБОР ПРОЕКТА - Библиотека с высокой популярностью, но низким Bus factor - Библиотека в стадии развития
44. Сontributing to open source СТАДИЯ 1 (ЛЮБОЗНАТЕЛЬНАЯ) - Создавать issue/feature request на github - Посмотреть внутреннее устройство библиотеки - Подписаться на репозиторий - Найти сообщество разработчиков библиотеки(Telegram/Slack/ Gitter)
45. Сontributing to open source СТАДИЯ 2 (ПОМОЩЬ С ОКРУЖЕНИЕМ) - Помочь с документацией - Написать тесты
46. Сontributing to open source СТАДИЯ 3 ( ) - Фиксить issue - Создавать новый функционал! !!! ПЕРЕД СОЗДАНИЕМ ФУНКЦИОНАЛА У З Н А Й Т Е М Н Е Н И Е О Н Е М У ВЛАДЕЛЬЦА РЕПОЗИТОРИЯ ПРОЕКТА!!!
47. Итоги - Разрабатывать библиотеки/фреймворки сложно - Все начинается с планирования, research и проектирования - Начните с contribution в чужие решения, это просто ;-)
48. 96 Вопросы?
49. Ссылки ЧАТ ПО АРХИТЕКТУРЕ https://t.me/Android_Architecture ANDROID ПОДКАСТЫ https://t.me/androiddevpodcast