Хотите внести свой вклад в проекты с открытым исходным кодом? Вот как начать

Маскот GitHub — существо, похожее на кошку с пятью щупальцами, в очках, держащее яблоко и указку.

Быстрые ссылки

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

Что такое Git и что такое GitHub?

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

GitHub — это веб-приложение, которое использует Git для хостинга и управления более чем 420 миллионами репозиториев (репов), которые обычно являются проектами с открытым исходным кодом. Сайт добавляет функции на основе Git, включая системы отслеживания ошибок, управление задачами и вики. Тем не менее, GitHub не обязателен для использования Git, и существует множество альтернатив GitHub, включая GitLab и Gitea. Однако первый проект, в который вы захотите внести свой вклад, вероятнее всего, будет на GitHub, поэтому мы показываем его именно здесь.

Домашняя страница GitHub.com с крупной надписью, которая гласит: "Создавайте и поставляйте программное обеспечение на одной совместной платформе."

Коммиты и запросы на изменение: объяснение

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

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

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

Как сделать и отправить изменение

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

Не делайте тестовые коммиты или запросы на изменения в проектах, если это явно не разрешено. Для этого руководства вы можете редактировать файл README.md в созданном нами образцовом репозитории.

Зарегистрируйтесь на GitHub

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

Форма регистрации на GitHub с полем для ввода адреса электронной почты.

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

Дашборд GitHub с ссылками на "Введение в GitHub" и другие способы начать использование сайта.

Найдите репозиторий

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

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

На сайте проекта обычно есть ссылка на его репозиторий на GitHub. Ищите ссылку в правом верхнем углу с надписью «Сделайте форк на GitHub» или фразами вроде «Найдите эту страницу на GitHub» рядом с логотипом «octocat» GitHub.

В правом верхнем углу веб-сайта находится ссылка с надписью "Сделайте форк на GitHub."

Отредактируйте файл

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

Отдельный файл на GitHub с выделенной кнопкой "Редактировать этот файл".

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

Сообщение на GitHub, которое гласит: "Вам нужно сделать форк этого репозитория, чтобы предложить изменения."

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

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

Текстовый редактор GitHub, показывающий изменения в файле в процессе.

После того как вы обновите файл, нажмите кнопку «Закрепить изменения». Добавьте полезное «Расширенное описание» в текстовом поле, которое появится далее. Вам не нужно объяснять, что вы изменили в деталях, только почему вы это сделали. На данный момент вы можете оставить это просто: «Исправил опечатку» или «Заменил неработающую ссылку» подойдут.

Откройте запрос на изменение

Нажмите «Предложить изменения». Это должно перенести вас на страницу с заголовком «Сравнение изменений», которая показывает детали вашего обновления. Нажмите «Создать запрос на изменение.»

GitHub показывает изменения, которые собираются быть отправлены как запрос на изменение.

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

Вы окажетесь на странице запросов на изменения для оригинального репозитория проекта.

Что произойдет дальше?

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

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

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

Если вам понравилась эта статья, подпишитесь, чтобы не пропустить еще много полезных статей!

Новинка! На нашем канале в Яндекс Дзен появилась премиум подписка, которая позволяет читать статьи без рекламы и получать доступ к эксклюзивным материалам, недоступным обычным пользователям. Будем рады, видеть вас в числе премиум пользователей!

Вы также можете читать наши материалы в:

Алекс Бежбакин
Оцените автора
Добавить комментарий