Зачем участвовать в опенсорс-проектах?

Участие в опенсорс-проектах может быть полезным способом изучать, обучать и приобретать опыт практически в любом навыке, который вы можете себе представить.

Зачем люди участвуют в опенсорсе? На то есть множество причин!

Улучшить используемые проекты

Многие опенсорс-контрибьюторы перед тем, как внести свой вклад в продукт, были обычными его пользователями. Если вы обнаружите баг в используемой вами опенсорс-программе вы, возможно, захотите заглянуть в её исходный код, чтобы узнать, сможете ли вы исправить его самостоятельно. Если это так, то отправка патча — лучший способ убедиться, что ваши друзья (и вы сами, когда вы обновитесь до следующего релиза) смогут извлечь из него пользу.

Улучшить существующие навыки

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

Познакомиться с людьми с общими интересами

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

Найти наставников и научить других

Работа с другими над общим проектом означает, что вам придется объяснять, как вы это делаете, а также просить помощи у других. Акты обучения и преподавания могут быть полезными для всех участников.

Создать общедоступные проекты, которые помогут вам повысить репутацию (и карьеру)

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

Изучить навыки работы с людьми

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

Возможность внести изменения, пусть даже небольшие

Необязательно становиться контрибьютором на протяжении всей жизни, чтобы получать удовольствие от участия в опенсорс-проектах. Вы когда-нибудь видели опечатку на сайте и хотели бы, чтобы кто-нибудь её исправил? В проекте с открытым исходным кодом вы можете это сделать. Опенсорс помогает людям чувствовать хозяевами своей жизни и того , как они воспринимают мир, и это само по себе отрадно.

Что значит внести свой вклад

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

Не беспокойтесь! Много чем можно заняться в опенсорс-проекте, и вот несколько подсказок, которые помогут вам определиться, чтобы извлечь максимальную пользу.

Необязательно помогать кодом

Распространенное заблуждение, касающееся участия в опенсорсе, состоит в том, что вам нужно писать код. Зачастую есть другие части проекта, которыми наиболее всего пренебрегают или упускают из виду. Вы окажете проекту огромную услугу, предложив поработать над ними!

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

Нравится планировать мероприятия?

  • Организуйте семинары или митапы по проекту, что и сделал @fzamperin в NodeSchool
  • Организуйте конференцию проекта (если она есть)
  • Помогите участникам сообщества найти подходящие конференции и подать заявку на доклад

Нравится дизайнить?

  • Переделайте макеты, чтобы повысить удобство использования проекта
  • Проведите исследование поведения пользователей, чтобы реорганизовать и улучшить навигацию или меню проекта, например, как предлагает Drupal
  • Составьте руководство по стилю оформления, чтобы помочь проекту с соблюдением единообразного визуального дизайна
  • Создайте принты для футболок или новый логотип, как это сделали участники hapi.js

Нравится писать?

  • Напишите и улучшите документацию по проекту
  • Создайте папку с примерами по использованию проекта
  • Запустите рассылку новостей по проекту или освещайте самое важное из списка рассылки
  • Составьте обучающие руководства по проекту, как это сделали участники PyPA
  • Переведите документацию проекта

Нравится организовывать?

  • Давайте ссылки на повторяющиеся ишью, предлагайте новые ярлыки для ишью, чтобы они были лучше огранизованы
  • Пройдитесь по открытым ишью и предложите закрыть старые, как например сделал @nzakas в ESLint
  • Задавайте уточняющие вопросы по недавно открывшимся ишью, чтобы продвинуть обсуждение вперед

Нравится кодить?

  • Найдите открытую проблему для решения, что например @dianjin сделал в Leaflet
  • Спросите, можете ли вы помочь с разработкой новой функциональности
  • Автоматизируйте настройку проекта
  • Улучшите инструменты и тестирование

Нравится помогать людям?

  • Ответьте на вопросы о проекте, например, на Stack Overflow (как в этом примере с Postgres) или Reddit
  • Отвечайте на вопросы людей по открытым ишью
  • Помогите модерировать доски обсуждений или каналы в чатах

Нравится ли вам помогать другим кодить?

  • Проверяйте код других людей
  • Напишите учебные руководства по использованию проекта
  • Предложите наставничество другому контрибьютору, как @ereichert сделал для @bronzdoc в Rust

Можно работать не только над программными проектами!

Хотя «опенсорс» часто относится к программному обеспечению, вы можете совместно работать практически над чем угодно. Есть книги, рецепты, списки и курсы, которые разрабатываются как опенсорс-проекты.

Например:

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

Подготовка к новому проекту

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

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

Анатомия опенсорс-проекта

Каждое сообщество с открытым исходным кодом отличается.

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

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

Типичный проект с открытым исходным кодом состоит из следующих типов людей:

  • Автор: Человек или организация, создавшие проект.
  • Владелец: Лицо, которое имеет административные права на организацию или репозиторий (не всегда те же самые, что и первоначальный автор).
  • Мейнтейнеры: Контрибьюторы, которые несут ответственность за формирование видения и управление организационными аспектами проекта (они также могут быть авторами или владельцами проекта).
  • Контрибьюторы: Все, кто внес свой вклад в проект.
  • Участники сообщества: Люди, использующие проект. Они могут быть активными в беседах или высказывать свое мнение о направлении проекта.

В более крупных проектах также могут быть подкомитеты или рабочие группы, занимающиеся различными задачами, такими как инструменты, сортировка, модерация сообщества и организация мероприятий. Поищите на сайте проекта или репозитории “командную” или “организационную” страницу, чтобы найти эту информацию.

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

  • LICENSE: По определению, каждый опенсорс-проект должен иметь соответствующую лицензию. Если у проекта нет лицензии, его нельзя перечислить к опенсорсу.
  • README: README — это руководство-инструкция, которая приветствует новых членов сообщества в проекте. В этой файле объясняется назначение и применение проекта.
  • CONTRIBUTING: В то время как README помогают людям использовать проект, документация по участию помогает людям вносить вклад в проект. В нем объясняется, какие виды помощи необходимы и как устроен процесс. Хотя не у каждого проекта есть файл CONTRIBUTING, его наличие свидетельствует о дружелюбном отношении к участникам.
  • CODE_OF_CONDUCT: Кодекс поведения устанавливает основные правила поведения участников и помогает создать дружелюбную, гостеприимную атмосферу. Хотя не в каждом проекте есть файл CODE_OF_CONDUCT, его наличие свидетельствует о том, что это хороший проект, в который можно внести свой вклад.
  • Другая документация: Может быть дополнительная документация, например обучающие материалы, пошаговые руководства или политики управления, особенно для более крупных проектов.

Наконец, в проектах с открытым исходным кодом для организации обсуждения используются следующие инструменты. Чтение архивов даст вам хорошее представление о том, как сообщество думает и работает.

  • Список ишью (issue tracker): Место, где происходят обсуждения, связанные с проектом.
  • Пул-реквесты (pull requests): Место, где рассматриваются запросы на изменение кода.
  • Дискуссионные форумы или списки рассылки: Некоторые проекты могут использовать эти каналы для разговорных тем (например, “Как мне …“ или “Что вы думаете о …“ вместо отчётов об ошибках и внесения предложений с новыми возможностями). Другие используют ишью для всех дискуссий.
  • Синхронный чат-канал: Некоторые проекты используют чаты (например, Slack или IRC) для спонтанного общения, совместной работы и быстрого обмена информацией.

Поиск проекта, в котором можно поучаствовать

Теперь, когда вы разобрались, как устроены опенсорс-проекты, пришло время найти проект, в который вы сможете внести свой вклад!

Если вы никогда раньше не имели дело с опенсорсом, прислушайтесь к совету президента США Джона Ф. Кеннеди, который однажды сказал: «Не спрашивайте, что ваша страна может сделать для вас, спросите, что вы можете сделать для своей страны».

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

Вместо этого подумайте о проектах, которые вы уже используете или собираетесь использовать. Проекты, в которых вы будете активно участвовать, — это те, к которым вы будете возвращаться.

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

Опенсорс — это не закрытый клуб; им занимаются такие же люди, как вы. «Опенсорс» — это всего лишь причудливый термин для обозначения решаемых мировых проблем.

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

28% случайных вкладов в опенсорс представляют собой документацию, например, исправление опечатки, переформатирование или перевод.

Если вы ищете существующие ишью, которые можно исправить, то в каждом опенсорс-проекте есть страница /contribute, где вы перечислены ишью, специально предназначенные для начинающих. Перейдите на главную страницу репозитория на GitHub и добавьте в конец URL-адреса /contribute (например, https://github.com/facebook/react/contribute`).

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

Чеклист перед тем, как принять участие

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

Вот удобный чеклист список, чтобы понять, подходит ли проект для новых контрибьюторов.

Попадает под определение опенсорса

Проект активно принимает стороннюю помощь

Посмотрите на коммиты в основной ветке. Узнать это вы можете на главной странице репозитория на GitHub.

Затем посмотрите на ишью проекта.

Теперь выясните такую информацию про пул-реквесты проекта.

Проект приветливый

Дружелюбный и доброжелательный проект свидетельствует о том, что в нём будут с пониманием относится к новыми контрибьюторам.

Как сделать вклад

Вы нашли понравившийся проект, и уже готовы поучаствовать в нём. Наконец-то! И вот как правильно это сделать.

Эффективное общение

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

Прежде чем открывать ишью, пул-реквест, или задать вопрос в чате, запомните эти советы, которые помогут эффективно реализовать ваши идеи в жизнь.

Дайте контекст. Помогите другим быстро освоиться. Если вы столкнулись с ошибкой, объясните, что вы пытаетесь сделать и как ее воспроизвести. Если вы предлагаете новую идею, объясните, почему вы думаете, что она будет полезна для проекта (не только для вас!).

😇 “Х не происходит, когда я делаю Y”

😢 “X не работает! Исправьте это.”

Попробуйте сначала разобраться сами. Не знать чего-то — это нормально, но покажите, что вы пробовали разобраться. Прежде чем обращаться за помощью, обязательно изучите README-файл проекта, документацию, ишью (открытые или закрытые), список рассылки и поищите ответ в Интернете. Люди оценят, когда вы продемонстрируете, что попытались что-то узнать.

😇 “Я не знаю, как реализовать X. Я посмотрел документацию и не нашел никаких упоминаний об этом.”

😢 “Как мне сделать X?”

Пишите коротко и по делу. Как и при отправке электронного письма, каждая сторонняя работа, независимо от того, насколько она была простой или полезной, требует чьей-то проверки. Во многих проектах входящих запросов больше, чем людей, готовых помочь. Будьте лаконичны. Так вы увеличите шанс того, что кто-то сможет вам помочь.

😇 “Я хотел бы написать руководство по API.”

😢 “На днях я ехал по шоссе и остановился заправиться, и тогда у меня возникла замечательная идея, чем мы должны заняться, но прежде чем я это объясню, позвольте мне показать вам …“

Ведите все обсуждения публично. Хотя это заманчиво, не обращайтесь к мейнтейнерам напрямую, если вам не нужно делиться конфиденциальной информацией (например, о проблеме безопасности или серьезном нарушении поведения). Если вы сделаете беседу публичной, больше людей смогут узнать о ней и извлечь из неё пользу. Обсуждения сами по себе могут быть вкладом.

😇 (в качестве комментария) «@-мейнтейнер Привет! Как нам поступить с этим пул-реквестом?»

😢 (по электронной почте) «Привет, извини, что побеспокоил тебя по электронной почте, но мне было интересно, была ли у тебя возможность просмотреть мой PR»

Не стесняйтесь задавать вопросы (но будьте терпеливы!). В какой-то момент каждый был новичком в проекте, и даже опытным контрибьютором нужно время освоиться, когда они приходят в новый проект. Точно так же уже давние мейнтейнеры не всегда знакомы со всеми частями проекта. Проявите к ним такое же терпение, какое вы бы хотели, чтобы они проявили к вам.

😇 “Спасибо, что разобрались с этой ошибкой. Я последовал вашим предложениям. Вот результат.”

😢 “Почему вы не можете решить мою проблему? Разве это не ваш проект?”

Уважайте решения сообщества. Ваши идеи могут отличаться от приоритетов или видения сообщества. Они могут высказать свои мнения или отказаться от реализации вашей идеи. Хотя всегда нужно обсуждать и искать компромисс, последнее слово за мейнтейнерами, потому что им в дальнейшем предстоит работать с вашим кодом. Если вы не согласны с их направлением, вы всегда можете работать над собственным ответвлением проекта (форком) или начать собственный проект.

😇 “Я разочарован, что вы не можете поддержать мой вариант использования, но, как вы объяснили, он затрагивает только небольшую часть пользователей, я понимаю почему. Спасибо за внимание.”

😢 “Почему вы не поддерживаете мой вариант использования? Это недопустимо!”

Главное, держите себя в руках. Опенсорсом занимаются люди со всего мира. Контекст теряется из-за разных языков, культур, регионов и часовых поясов. Кроме того, письменное общение затрудняет передачу тона или настроения. В таких обсуждениях исходите из благих намерений. Нет ничего плохого в том, чтобы вежливо оттолкнуться от идеи, попросить больше информации или дополнительно прояснить свою позицию. Просто постарайтесь сделать интернет лучше, чем когда вы его нашли.

Изучение обстановки

Прежде чем что-либо делать, убедитесь, что это больше нигде не обсуждалась. Пройдитесь по README-файлу проекта, ишью (открытые и закрытые), списку рассылки и Stack Overflow. Не тратьте много времени на это, достаточно поискать по нескольким ключевым словам.

Если вы не нашли обсуждение вашей идеи, можно начать действовать. Если проект находится на GitHub, вы, скорее всего, будете общаться, открывая ишью или пул-реквест:

  • Ишью отлично подходят, чтобы завести беседу или обсуждение
  • Запросы на изменение предназначены для начала работы над решением.
  • Для легкого общения, например, уточняющего или практического вопроса, попробуйте задать вопрос в Stack Overflow, IRC, Slack или других чат-каналах, если он есть в проекте

Прежде чем открывать ишью или пул-реквест, ознакомьтесь с руководством по участию (обычно ему посвящен отдельный файл с именем CONTRIBUTING или соответствующий раздел в файле README), чтобы сделать всё правильно. Например, вас могут попросить представить информацию согласно шаблону или потребовать, чтобы вы написали тесты.

Если вы планируете сделать большое изменение, перед этим лучше откройте ишью. Полезно некоторое время понаблюдать за проектом (на GitHub для этого можно кликнуть по кнопке «Watch», чтобы получать уведомления обо всех активностях), а также познакомиться с некоторыми участниками сообщества.

Открытие ишью

Как правило, следует создать ишью чтобы:

  • Сообщить об ошибке, которую вы не можете исправить самостоятельно
  • Обсудить общую тему или идею (например, связанную с сообществом, развитием или политикой проекта)
  • Предложить реализовать новую функциональность или другую идею проекта

Советы по общению в ишью:

  • Если видите открытую ишью, которую хотите решить прокомментируйте её, чтобы люди знали, что вы занимаетесь ею. Таким образом, снизится вероятность, что кто-то ещё будет работать над ней.
  • Если ишью была открыта давно, возможно, что она рассматривается в другом месте, либо уже решена, поэтому прокомментируйте её, чтобы подтвердить её актуальность.
  • Если вы открыли ишью, но позже самостоятельно нашли ответ, прокомментируйте её, чтобы сообщить об этом людям, а затем закройте её. Даже фиксирование такого результата является вкладом в проект.

Открытие пул-реквеста

Как правило, следует создать пул-реквест чтобы:

  • Сделать незначительное исправление (например, исправить опечатку, неработающую ссылку или очевидную ошибку)
  • Начать работать над тем, о чём уже было договорено или что обсуждалось в ишью

Пул-реквест не обязательно должен представлять законченную работу. Обычно лучше открывать пул-реквест на раннем этапе, чтобы люди могли наблюдать за вашим прогрессом или оставлять отзывы о нем. Только в названии таком пул-реквесте укажите “WIP” (от англ. Work in Progress — в процессе выполнения). Всегда позже можно отправить дополнительные коммиты.

Если проект находится на GitHub, выполните следующие шаги, чтобы создать пул-реквест:

  • Форкните репозиторий и склонируйте его к себе локально. Затем в этом локальном репозитории добавьте оригинальный (upstream) репозиторий. Почаще загружайте изменения из исходного репозиторий, чтобы ваш локальный репозиторий оставался в актуальном состоянии, — это снизит появление конфликтов при создании пул-реквеста. (См. более подробные инструкции здесь.)
  • Создайте ветку для ваших правок.
  • Ссылайтесь на любые относящиеся к делу ишью или подтверждающую документацию в своем PR (например, «Closes #37»).
  • Добавьте скриншоты до и после, если ваши изменения затрагивают файлы HTML/CSS. Перетащите изображения в текстовую область пул-реквеста.
  • Протестируйте свои изменения! Например, если есть, запустите тесты, и при необходимости напишите новые. Даже если нет тестов, проверьте сами, что после ваших изменений всё работает, как и раньше.
  • Соблюдайте стиль написания кода проекта в меру своих возможностей. Это может быть использование отступов, точек с запятой или комментариев иначе, чем вы привыкли, но мейнтейнерам это упросит слияние вашего пул-реквеста, а другим — облегчит понимание и поддержку в будущем.

Если это ваш первый пул-реквест, ознакомьтесь с сайтом Make a Pull Request, которую @kentcdodds сделал в виде пошагового видео-руководства. Вы также можете попрактиковаться в создании пул-реквеста в репозитории First Contributions, созданном @Roshanjossey.

Что будет дальше после принятия участия

Вы сделали это! Поздравляем, вы стали контрибьютором в опенсорс. Надеемся, это будет далеко не первый раз.

После того, как вы отправите вклад, произойдет одно из следующих событий:

😭 Вы не получите ответ.

Предполагаем, вы проверили проект на наличие признаков активности перед тем, как внести свою лепту. Однако даже в активном проекте возможно, что ваш вклад не получит отклика.

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

Не обращайтесь напрямую к этому человеку; помните, что публичное общение жизненно важно для опенсорс-проектов.

Если после вежливого напоминания так и никто не ответил, есть вероятность, что никто и никогда не ответит. Это не самое приятное ощущение, но пусть оно вас не расстраивает. Такое с каждым случалось! Есть множество возможных причин, по которым вам не ответили, в том числе личные обстоятельства, на которые вы можете повлиять. Попробуйте найти другой проект или способ участия. Во всяком случае, нет больше смысла вкладываться в такие проекты, по крайней мере до того момента, когда объявятся другие члены сообщества.

🚧 У вас могут запросить внести изменения.

Зачастую вас могут попросить что-то изменить, это может быть связано с самой идеей или её реализацией.

Когда кто-то запрашивает сделать изменения, относитесь к этому с пониманием и воспринимайте это должным образом. Люди нашли время, чтобы оценить ваш вклад. Открывать PR и бросать его на произвол судьбы — дурной тон. Если вы не знаете, как внести изменения, изучите проблему, а затем обратитесь за помощью, если она вам нужна.

Если у вас больше нет времени работать над проблемой (например, обсуждение длится уже несколько месяцев, а за это время обстоятельства поменялись), сообщите об этом мейнтейнеру, чтобы он не ожидал ответа. Возможно кто-то другой с радостью завершит начатую вами работу.

👎 Ваш вклад не принят.

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

🎉 Ваш вклад принят.

Ура! Вы успешно сделали вклад в опенсорс!

Вы сделали это!

Независимо от того, сделали ли вы свой первый вклад в опенсорс или ищете новые способы сделать это, мы надеемся, что вы вдохновитесь на действия. Даже если ваш вклад был отклонён, не забудьте сказать спасибо, когда мейнтейнер постарался вам помочь. Опенсорс создается такими же людьми, которые создают ишью, отправляют пул-реквест, оставляют комментарии или приветствуют друг друга одновременно.