Как внести свой первый вклад в открытый исходный код

Перед началом работы

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

Предполагается, что читатель обладает базовыми знаниями о Git, поэтому здесь не будут подробно описаны git-команды.

Что такое программное обеспечение с открытым исходным кодом?

Программное обеспечение с открытым исходным кодом (open source software, OSS)  —  это ПО, код которого находится в открытом доступе. Другие люди могут просматривать этот код, редактировать и изменять его и, по сути, вносить свой вклад в его улучшение. Кодовая база любой системы  —  будь то библиотека, приложение, сайт или даже операционная система  —  это та часть, которая находится “за кулисами” этих проектов и обеспечивает их работу.

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

Кто может внести свой вклад?

Любой может внести свой вклад в открытый исходный код. И речь идет не только о разработчиках!

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

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

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

Почему это важно?

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

Еще одна веская причина вносить свой вклад в OSS  —  возможность оказать поддержку своему или другим сообществам (о чем вы можете и не подозревать) и даже изменить свой карьерный путь.

Первое выявление проблемы

Если вы читали этот пост с самого начала, можете сказать: “Но я нигде не нашел неработающей ссылки, как же мне все-таки внести свой первый вклад?”. Главное  —  найти подходящую проблему, достаточно простую, чтобы уверенно с нее начать, и достаточно серьезную, чтобы ощутить весомость своего вклада.

Есть много способов поиска проблемы для внесения первого вклада. Некоторые члены OSS-сообщества постарались упростить этот процесс, создав для новичков замечательные ресурсы:

• First Contributions;
• Good first issues;
• Up for Grabs.

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

Начало работы: GitHub

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

Создание форка (ответвления)

Первое, что нужно сделать, чтобы внести свой вклад в OSS,  —  форкнуть его репозиторий, то есть создать ответвление проекта.

Согласно руководству GitHub, после некоторого времени самостоятельного использования платформы вы можете обнаружить, что хотите внести свой вклад в чей-то проект. Или, возможно, вы захотите использовать чей-то проект в качестве отправной точки для собственного. Этот процесс известен как форкинг. Откройте эту ссылку в браузере, в правом верхнем углу проекта есть кнопка fork, нажмите на нее.

Клонирование

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

Откройте Finder в выбранной вами папке и затем откройте терминал в этой папке. После этого выполните приведенную ниже команду:

git clone https://github.com/ВАШЕ_ИМЯ_НА_GITHUB/first-contributions.git

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

Коммиттинг и отправка изменений

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

Все это делается с помощью трех команд:

git add Contributors.md

git commit -m "Added Lotanna to the Contributors list"

git push -u origin master

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

Отправка PR

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

Запрос на исправление (pull request, PR)  —  это просьба к владельцам проекта или сопровождающим его лицам перенести ваши изменения в основной проект.

Теперь взгляните на форкнутую версию. Вы увидите, что в вашей ветке больше на 1 изменение (коммит), чем в основном проекте. Нажмите кнопку pull request, и GitHub проанализирует ваше изменение, чтобы определить, подходит ли оно для слияния с основным проектом, а затем отобразит кнопку submit a pull request. Нажмите на нее и подробно объясните внесенное вами изменение. В вашем случае это будет выглядеть примерно так: “Я добавил свое имя в список соавторов”.

Contributing.mds

Каждый OSS-проект, особенно на GitHub, должен иметь гайд для авторов вкладов. В большинстве проектов он называется contributing.md. Обычно это документ в формате markdown, в котором владельцы и сопровождающие проекта указывают, как вносить вклад в их проект, чтобы можно было легко отслеживать и объединять PR, а также для ясности.

GitHub напомнит вам о необходимости изучить его перед отправкой PR, так что не волнуйтесь: вы его не пропустите.

Поздравляем!

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

Читайте также:

• Как создавать надежные SSL-сертификаты для локальной разработки
• Пять продвинутых Git-команд, благодаря которым вы будете выглядеть как профи
• 5 ключевых правил успешного ревью кода

Читайте нас в Telegram, VK и Яндекс.Дзен

---

Перевод статьи Nwose Lotanna: How to Make Your First Open Source Contribution