Готовим код в мир открытых исходников
•
0 likes•319 views
Как начать свой путь в мире Open Source
Готовим код в мир открытых исходников
- 1. Готовим код в мир открытых исходников Women Techmakers Novosibirsk International Women’s Day 2017 09.04.2017 Елена Граховац
- 2. Елена Граховац twitter.com/webdeva github.com/rumyantseva elena@grahovac.me бэкенд-разработчик в Openprovider соведущая подкаста GolangShow
- 3. Open Source 3 - Внести свой вклад в развитие технологий - Получить опыт разработки - Поучиться у гуру - Найти новых друзей - Прославиться 🤓
- 5. Существующий проект 5 - Принести пользу - Улучшить продукт, которым пользуешься - Стать частью сообщества - Поучиться на чужих примерах написания кода - Получить кодревью от более опытных товарищей
- 6. Свой проект 6 - Реализовать давнюю идею - Попробовать себя в разработке “с нуля” - Добавить примеры кода в портфолио - Собрать команду единомышленников
- 7. GitHub.com мир открытых исходников и социальная сеть для разработчиков 7
- 8. education.github.com/pack инструменты и сервисы для студентов 8
- 10. Чем помочь? 10 - Реализовать фичу или пофиксить баг - Улучшить документацию - Перевести документацию или сайт проекта на иностранный язык - Оставить баг-репорт или фича-реквест
- 11. README.md 11 - Описание проекта - Инструкция по развертыванию - Краткая информация о том, как можно поучаствовать в проекте
- 12. CONTRIBUTING.md 12 Подробные правила участия в проекте Пример для golang/go
- 13. Issues 13 - В первую очередь — “help wanted” - В первую очередь — простые задачи - Вознаграждение за “bounty” - Сначала согласовать, потом начать реализацию тикета
- 15. Fork & Pull Request 15 - Какую ветку форкать? - Стандарты кодирования - Правила оформления кода и коммитов - Тесты - В какую ветку делать Pull Request? - Правила оформления Pull Request’ов
- 18. README.md 18 - Описание проекта - Инструкция по развертыванию - Информация о том, как можно поучаствовать в проекте (или файл CONTRIBUTING.md) - Список контрибьюторов (или файл CONTRIBUTORS) Всё то же самое 🤓
- 20. Модель работы с Git 20 - Git flow (master, develop, feature, release, hotfix) - Свой вариант - Теги!
- 21. Семантическое версионирование 21 semver.org - Мажорная.Минорная.Патч - Обратная совместимость - Начинать с нуля? 0.0.1 или 0.1.0? - Суффиксы (alpha, beta, rc)
- 22. Стандарты кодирования 22 - Выбрать стандарт и следовать ему! - Описать правила для контрибьютеров - Хуки на коммит на стороне клиента (pre- commit.com) - Хуки на пуш на стороне сервера
- 23. Документация 23 - Минимальная — в README.md - Автодокументация, сгенерированная по коду - Документация для библиотеки - Документация для REST API
- 24. Тесты 24 - Правильность кода - Пример использования кода - Помощь контрибьюторам
- 25. Автосборка 25 - Проверить код на соответствие стандартам - Запустить тесты - Запустить сборку (если требуется) - Удобно: travis-ci.com для проектов с открытым исходным кодом
- 26. Собираем бейджи 26 - Текущая версия - Успешность сборки - Документирование - Покрытие тестами - Соответствие стандартам кодирования - Привлечение внимания - … badges/shields
- 27. Issues & Projects 27 - Теги для тикетов - Планирование версий (“milestones”) - Объединение крупных фич в проекты - Общение с контрибьюторами
- 28. Что ещё? 28 - Создать чат для общения с пользователями и контрибьюторами (gitter.im) - Рассказать про свой проект в тематических сообществах - Подгтовить доклад о своем проекте на ближайший митап
- 29. Елена Граховац twitter.com/webdeva github.com/rumyantseva elena@grahovac.me бэкенд-разработчик в Openprovider соведущая подкаста GolangShow