Запуск open source проекта

‼️ Сейчас все наши стартапы готовят open source код. Исключения будут по решению product owner новых стартапов.

Открывать исходники можно в любой удобный для команды момент, важно правильно подготовить документацию.

🔴 Шаг 1. Выбор Лицензии open source.

🔺Лицензии с открытым исходным кодом предоставляют любому пользователю разрешение на использование, модификацию и обмен лицензионным программным обеспечением для любых целей на условиях сохранения происхождения и открытости программного обеспечения.

🔺Самые популярные лицензии:

📌GNU AGPLv3
📌GNU GPLv3
📌GNU LGPLv3
📌Mozilla Public License 2.0
📌Apache License 2.0
📌MIT License
📌Boost Software License 1.0
📌The Unlicense

🔴 Шаг 2. Создать файл README

🔺README - это текстовый файл, который содержит информацию, необходимую для понимания того, о чем идет речь в проекте.

🔴 Шаг 3. Руководство для участников

🔺Файл CONTRIBUTING должен содержать информацию о технических деталях для тех, кто хочет присоединиться к проекту.
🔺Здесь же можно изложить свои ожидания относительно участия других людей.

🔴 Шаг 4. Кодекс поведения

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

Лицензия MIT

💡💡💡Короткая и простая разрешительная лицензия с условиями, требующими только сохранения авторских прав и лицензионных уведомлений. Лицензируемые произведения, модификации и более крупные произведения могут распространяться на различных условиях и без исходного текста.

✅Лицензия разрешает:

❕Использовать данное программное обеспечение и производные в личных и коммерческих целях; распространять и видоизменять.

⚠️Условия:

Копия лицензии и уведомление об авторском праве должны быть включены в программное обеспечение.

⛔️Ограничения:

▫️Данная лицензия включает в себя ограничение ответственности.
▫️Лицензия недвусмысленно заявляет, что она НЕ дает никаких гарантий.

https://opensource.org/licenses/MIT

Интересный проект, который дает возможность с/с++ код компилировать для WebAssembly, что позволяет запускать программы на с/с++ в браузере и node.js. https://github.com/emscripten-core/emscripten

#open_source_licenses

Как написать README

🟠 Имя
Важно выбрать самообъясняющее название для своего проекта.

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

🟠 Визуальный ряд
Если есть визуальная информация, скриншоты или даже видео, то включить их в этот файл тоже стоит.

🟠 Установка
Перечислите конкретные шаги, которые нужны для использования вашего проекта. Если он работает в определенной версии языка программирования, например, или есть другие условия, добавьте подраздел Требования.

🟠 Использование
Полезно иметь в строке самый маленький пример использования, который можно продемонстрировать.

🟠 Поддержка
Обязательно написать контакты, чтобы можно было к вам обратиться за помощью.

🟠 Дорожная карта
Если у вас есть идеи насчет релизов в будущем, хорошо бы их перечислить в README.

🟠 Вклад
Укажите, открыты ли вы для взносов и каковы ваши требования к их приему.
Для людей, которые хотят внести изменения в ваш проект, полезно иметь некоторую документацию о том, как начать работу.

🟠 Авторы и подтверждение
Покажите свою признательность тем, кто внес вклад в проект.

🟠 Лицензия
Для проектов с открытым исходным кодом скажите, как он лицензирован.

🟠 Статус проекта
Если у вас закончились энергия или время для вашего проекта, поместите в верхней части README заметку, что разработка замедлилась или остановилась полностью.

Друзья, если Вы хотите:

💡 реализовать ИДЕЮ
🚀 запустить STARTUP
🏆 собрать КОМАНДУ
🦄 разработать MVP

⚠️ Без рисков и вложений

Присоединяйтесь: https://startupemulator.com

‼️ Если у вас есть вопросы, обязательно задавайте: @Diana_Kucherenko

#startup

‼️Startup
Join one or start your own and build a minimum viable product​.

‼️Emulator
Start the development process with a cross-functional team​.

‼️Training
Improve your problem-solving and technical skills​.

‼️Platform
Learn new technologies and programming languages​.

#open_source_licenses

Разработка КОДЕКСА ПОВЕДЕНИЯ УЧАСТНИКА

🟣Кодекс поведения задаёт базовые правила поведения для участников вашего проекта.

🟠По аналогии с лицензией, составлять кодекс не обязательно, существуют готовые варианты.

🟡 Файл CODE_OF_CONDUCT.md следует поместить в корень проекта, так его будет проще находить и ссылаться на него, например, из README.

🟢В текст кодекса входят следующие пункты:

🟪Обязательства
🟦Стандарты
🟧Обязанности
🟥Область применения
🟩Претензии

Например, Кодекс Поведения основанный на Contributor Covenant, доступен в версии 1.4.0 (переведён на 30+ языков), а новая версия 2.0 - на 6 языках, в том числе на английском.

#Useful_links

Contributor Covenant v2.0
You can view and download the latest version of the Contributor Covenant here:
• English (Markdown version)
• English (HTML version)
• English (text version)
For translations of the Contributor Covenant, please see our translations page.

The Django Code of Conduct and the Citizen Code of Conduct are also two good code of conduct examples.

#open_source_licenses

Написание руководства для участников

🟡Файл CONTRIBUTING - это своеобразная инструкция для всех тех, кто хочет стать участником вашего проекта.

🟡Здесь можно описать технические детали:
▫️Как сообщить об ошибке
▫️Как предложить новую функцию
▫️Как настроить среду выполнения и запустить тесты

🟡Можно перечислить свои ожидания относительно участия других людей:
▫️Какого рода участие вы ждёте?
▫️Ваши планы и видение развития проекта.
▫️Как участники могут (и не могут) связываться с вами.

🟡Поставьте ссылку на файл CONTRIBUTING внутри README, так больше людей увидят его.

#Useful_links

Шаблон написания файла Contributing

https://github.com/nayafia/contributing-template/blob/master/CONTRIBUTING-template.md

#Useful_links

Руководство по написанию

How to Build a CONTRIBUTING

https://mozillascience.github.io/working-open-workshop/contributing/#introduction

#open_source_licenses

Boost Software License 1.0

🟪Простая неограничительная лицензия, требующая только сохранения авторских прав и лицензионных уведомлений для распространения исходного текста (а не двоичного).
🟧Лицензируемые работы, модификации и более крупные работы могут распространяться на различных условиях и без исходного текста.
🟦Данное программное обеспечение и производные могут быть использованы, распространены и изменены в коммерческих и частных целях.

✅Условия✅
Копия лицензии и уведомление об авторском праве должны быть включены в программу в виде исходного текста, но не требуется для двоичных файлов.

🟥Данная лицензия включает в себя ограничение ответственности.

🟥Лицензия недвусмысленно заявляет, что она НЕ дает никаких гарантий.

https://www.boost.org/LICENSE_1_0.txt

Движек чат бота, который позволяет в 6 строк сделать бот на JS, Python, Go или Java. Написан на JavaScript. https://github.com/wechaty/wechaty

#open_source_licenses

Boost Software License 1.0

🟪Простая неограничительная лицензия, требующая только сохранения авторских прав и лицензионных уведомлений для распространения исходного текста (а не двоичного).
🟧Лицензируемые работы, модификации и более крупные работы могут распространяться на различных условиях и без исходного текста.
🟦Данное программное обеспечение и производные могут быть использованы, распространены и изменены в коммерческих и частных целях.

✅Условия✅
Копия лицензии и уведомление об авторском праве должны быть включены в программу в виде исходного текста, но не требуется для двоичных файлов.

🟥Данная лицензия включает в себя ограничение ответственности.

🟥Лицензия недвусмысленно заявляет, что она НЕ дает никаких гарантий.

https://www.boost.org/LICENSE_1_0.txt

#Useful_links

All about Code of Conduct

https://opensource.guide/code-of-conduct/

The Unlicense

Лицензия без условий

✅ Это свободное и необремененное программное обеспечение, выпущенное в общественное достояние.

📌”...Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software...”

✅Нелицензированные произведения, модификации и более крупные произведения могут распространяться на других условиях и без исходного текста.

✅Данное программное обеспечение и производные могут распространяться, изменяться, использоваться в коммерческих целях и в частном порядке.


⛔️Данная лицензия включает в себя ограничение ответственности.

⛔️Лицензия недвусмысленно заявляет, что она НЕ дает никаких гарантий.

⁠Что делать, если вам не выделили сервер? Как справиться с отсутствием почтового сервера? Невозможно начать работу над проектом без CI? Есть ресурс, который решает все ваши проблемы. Полный список бесплатных сервисов для разработчиков - https://free-for.dev/

#Useful_links


https://trefle.io

#Branching_merging
#Git_Flow
#Feature_Based_Development

Git Flow (Feature Based Development) — одна из первых крупных стратегий ветвления, которая описывает несколько веток для разработки, релизов и взаимодействия между ними.

В Git Flow используются следующие типы веток:

• Feature branches
• Release branches
• Hotfix branches

#Branching_merging
#Git_Flow
#Feature_Based_Development

Feature branches
1️⃣Могут бранчеватся от develop
2️⃣Должны вмержится в develop
3️⃣Naming convention: любые названия кроме master, develop, release-*, или hotfix-*

#Branching_merging
#Git_Flow
#Feature_Based_Development

Hotfix branches
1️⃣Могут бранчеватся от master
2️⃣Должны вмержится в develop и master
3️⃣Naming convention: hotfix-*