Вступление
Эта статья будет полезной разработчикам всех уровней, которым еще только предстоит сделать свой первый запрос на включение изменений в программный код. Она также предназначена для веб-дизайнеров, специалистов по подготовке технической документации, переводчиков и прочих экспертов, которые имеют отношение к такой технологии с открытым исходным кодом, как GitHub.
Автор этой статьи исходил из того, что у читателя уже есть базовые знания о Git, поэтому в ней не будет подробного описания команд git.
Что такое программное обеспечение с открытым исходным кодом?
ПО с открытым исходным кодом — это ПО, код которого находится в открытом доступе. Любой человек может просматривать, редактировать или изменять его и, по сути, вносить свой вклад в его улучшение. Кодовая база любой системы, будь то библиотека, приложение, веб-сайт, даже операционная система — это, по сути, закулисная часть этих проектов, обеспечивающая их работу.
Некоторые специалисты, которые пишут код для таких систем, решают сделать его открытым, чтобы другие могли видеть его и, по желанию, предлагать для него изменения. В этом и заключается смысл открытого исходного кода.
Кто может вносить изменения?
Любой может внести свой вклад в открытый исходный код. Да, вы правильно прочитали — любой! Не только разработчик! Ведь над программным продуктом трудятся не только разработчики, но и другие специалисты.
В эту команду входят заказчики и веб-дизайнеры продукта, авторы технической документации, переводчики, менеджеры по обеспечению качества, менеджеры по продукту и даже спонсоры проекта. Это те самые люди, которые обеспечивают целостную работу программного обеспечения, будь оно с открытым исходным кодом или нет.
Так что можете начинать уже сегодня. Возможно, вам уже попадалась неработающая ссылка в одном из ваших любимых веб-продуктов. Узнайте, имеет ли этот продукт открытый исходный код, и если это так, вы можете направить ваши предложения по его исправлению. Скорее всего, в данном случае речь может идти о замене URL-ссылки.
Почему это важно?
Внесение вклада в открытый исходный код очень полезно для вас, поскольку вы можете получить ценный опыт, общаясь с людьми из (скорее всего) разных слоев общества, учась с ними вместе и делясь друг с другом идеями. Это также отличный способ показать свою заинтересованность проектом, будь то приложение, библиотека или даже целевая страница.
Еще одна веская причина внести свой вклад в открытый код заключается в том, что таким образом вы помогаете своему сообществу и сообществам других людей (о чем вы можете даже не подозревать), и создаете предпосылки для собственного карьерного роста.
Поиск проблемы
Если вы читаете эту статью с самого начала, вы можете возразить: “Но мне еще не попадалась неработающая ссылка! Как же мне начать исправлять открытый код?”. Не переживайте. Главное — найти проблему, достаточно простую, чтобы вы смогли внести свое первое рацпредложение и попрактиковаться.
Есть много способов, с помощью которых новички находят проблемные коды, нуждающиеся в исправлении. Некоторые участники open-source-комьюнити постарались еще более упростить задачу, создав следующие замечательные ресурсы:
Там вы найдете массу возможностей сделать свой первый вклад в улучшение работы ПО с открытым кодом.
Начинаем с GitHub
Когда вы найдете проект с открытым исходным кодом, в который хотите внести изменения, останется приступить к практической части. Потренируемся на репозитории на GitHub. Попробуем дополнить список контрибьюторов, добавив в него наше имя.
Шаг 1. Форк
Первое, что нужно сделать, если хотите исправить ПО с открытым исходным кодом, — это форкнуть его.
Как говорится в GitHub-гайдах, после некоторого времени самостоятельного использования GitHub вы можете обнаружить, что некоторые проекты нуждаются в усовершенствованиях. Или, возможно, вы захотите взять чей-то проект в качестве отправной точки для своего собственного. В программирование это называется “форкинг”.
Откройте эту ссылку в браузере. В правом верхнем углу вы увидите кнопку Fork. Нажмите на нее.
Шаг 2. Клонирование
После форка вы увидите, что на странице проекта появился ваш ник на GitHub. Теперь проект есть на вашем профиле Github, и следующее, что нужно сделать, это клонировать его на ваш компьютер.
Откройте проводник, введите название выбранной вами папки, откройте терминал в этой папке, а затем выполните приведенную ниже команду:
git clone https://github.com/ВАШ_НИК_НА_GITHUB/first-contributions.git
Не забудьте заменить заглавные буквы на ваш ник на GitHub. Теперь смените каталог на только что клонированную папку и откройте файл contributors.md. Вы увидите имена других людей и свое имя в том же формате, в котором были добавлены другие. Сохраните файл.
Шаг 3. Коммит и отправка изменений
Далее нужно переслать сделанные изменения в версию файла на GitHub. Это называется отправкой изменений. Сначала вы добавляете изменения, чтобы сообщить Git’у, что хотите передать эти изменения для их отправки. Затем следует передать их с помощью оператора commit, а после этого отправить изменения.
Все это делается с помощью трех команд:
git add Contributors.md
git commit -m "Лотанна был добавлен в список контрибьюторов"
git push -u origin master
Если вы все выполнили правильно, то, когда вы перейдете в ваш браузер и посмотрите на список контрибьюторов в вашей форкнутой версии, вы должны увидеть там и свое имя.
Отправка запроса на включение изменений (PR)
Помните, что вы имеете полный доступ к своей собственной форкнутой версии проекта. Но цель состоит в том, чтобы внести вклад в основной проект — тот, который вы форкнули. Это делается путем подачи запроса на включение в проект сделанных вами изменений (PR).
Запрос на включение изменений — это просьба к владельцам или специалистам, сопровождающим проект, о перенесении ваших изменений в основной проект.
Теперь взгляните на форкнутую версию еще раз. Вы увидите, что ваша ветка на 1 коммит опережает основной проект. Нажмите кнопку pull request, и GitHub проанализирует предложенные вами изменения, чтобы определить, подходят ли они для слияния с основным проектом, а затем отобразит кнопку submit a pull request. Нажмите на нее и подробно расскажите о внесенных вами изменениях. В нашем случае можете написать примерно следующее: “Я добавил свое имя в список контрибьюторов”.
Contributing.mds
Каждый OSS-проект, особенно на GitHub, должен сопровождаться документом-руководством для контрибьюторов. В большинстве проектов он называется contributing.md. Обычно такой документ имеет формат markdown. В этом руководстве владельцы и специалисты, сопровождающие проект, указывают, как вносить изменения в их проект, чтобы можно было легко отслеживать и объединять запросы на включение изменений, а также для большей ясности.
GitHub напомнит вам о необходимости свериться с этим документом перед отправкой PR, так что не переживайте о том, что можете его не заметить.
Поздравляем! 🎉
Итак, вы отправили запрос на включение изменений. Поздравляем! Вы сделали свой первый вклад в открытый исходный код. Предложенные вами изменения будут включены в проект в ближайшее время.
Надеюсь, этот простой гайд поможет вам при внесении вашего первого вклада в ПО с открытым кодом. Мне интересно было бы узнать о вашем первом опыте и о том, в какой именно проект вы внесли свои изменения. Напишите об этом в комментариях. Удачного программирования!
Создавайте микрофронтенды с помощью программного обеспечения Bit с открытым исходным кодом
Вместо того чтобы собирать монолитные приложения, создавайте сначала независимые компоненты и компонуйте их в функции и приложения. Это ускоряет разработку и помогает командам создавать более последовательные и масштабируемые приложения.
Bit предлагает продвинутый инструментарий разработчика для создания независимых компонентов и компоновки приложений. Многие команды начинают с создания своих систем проектирования или микрофронтендов на основе независимых компонентов.
Читайте также:
- Как научиться не только писать код, но и быть хорошим программистом
- 4 лучших современных текстовых редактора с открытым исходным кодом для программирования в Linux
- 5 актуальных расширений Xcode для оптимизации разработки
Читайте нас в Telegram, VK и Яндекс.Дзен
Перевод статьи Nwose Lotanna, How to Make Your First Open Source Contribution
