Присоединяйтесь к тенденции социального программирования и вносите свой вклад в репозитории GitHub

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

Получить настройку

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

 git --version

Если вместо номера версии вы получите сообщение «команда не найдена», вы можете установить git с помощью команды:

 sudo apt-get -y install git

Разветвить репозиторий

Сначала вы должны выбрать репозиторий, в который вы хотите внести свой вклад, и посетить его в своем веб-браузере. Если вы не уверены, какой репозиторий выбрать, вы можете использовать демонстрационный репозиторий, расположенный по адресу https://github.com/mdizak/muo_demo . Это простая демонстрация, и вы можете создавать запросы на вытягивание для нее в целях тестирования и обучения.

При просмотре репозитория в веб-браузере найдите кнопку Fork Repository и щелкните ее. В результате репозиторий будет соединен с вашей учетной записью GitHub и вы попадете в него. Затем вам нужно клонировать вновь созданный репозиторий , поэтому откройте терминал на локальном компьютере и запустите:

 git clone https://github.com/myusername/muo_demo.git
 cd muo_demo

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

 git remote add upstream https://github.com/mdizak/muo_demo.git

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

Подготовить локальный репозиторий

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

 git checkout master
 git pull upstream master && git push origin master

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

Также не забудьте проверить, есть ли у проекта файл deposit.md, и если да, обязательно следуйте его указаниям. Иногда в проектах есть конкретные инструкции относительно того, как делать взносы, которым нужно всегда следовать.

Создать новую ветку

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

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

 git checkout -b feature/my_cool_feature

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

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

Зафиксировать и создать запрос на извлечение

Завершив работу над своим вкладом, зафиксируйте его с соответствующим сообщением о фиксации и отправьте его в свой разветвленный репозиторий с помощью команд:

 git commit --file commit.txt
 git push -u origin feature/my_cool_feature

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

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

Продолжайте вносить свой вклад в GitHub

Поздравляем, вы успешно внесли вклад в проект GitHub!

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